UUID basics & template

[Evil Overlord]

I have a stable EPUB that I tend to use as a template. It works fine, but it's only just occurred to me that perhaps it's reusing the same UUID over and over. It hasn't caused me any trouble, but is there a way to use a file as a template, and avoid this problem?

[Tex2002ans]

Originally Posted by Evil Overlord

I have a stable EPUB that I tend to use as a template. It works fine, but it's only just occurred to me that perhaps it's reusing the same UUID over and over. It hasn't caused me any trouble, but is there a way to use a file as a template, and avoid this problem?

You could just create a folder with all the common template files you use.

Create a new EPUB, Right-Click in the Book Browser + "Add Existing Files":



I have a folder of common CSS + Front/Backmatter that gets used in every book that I just import in every time. Then I do whatever tweaks are needed.

[Maui]

Another way is to copy & paste a new UUID from here

https://www.uuidgenerator.net/

or to write a plugin which is modifying the content.opf.

[KevinH]

Or remove the uuid dc:identifier and the content.opf will create a new one before saving it

Updated: whoops! This only works when the epub in question has obfuscated fonts!

So you would have to edit/add the bookid dc:identifier metadata and make sure it matches what is used in the ncx..

[DiapDealer]

I've always meant to knock together an input plugin that would allow a user to select from different predefined template epubs. Just never found the time.

[Evil Overlord]

Thanks, all.

@DiapDealer - I'd love to have that plugin (but have no idea how to make my own).

I think I'll try the UUID-generator site. In the case where this came up, I did try a bunch of things to make Sigil generate a new UUID, but they didn't work (perhaps because I don't have obfuscated fonts). I messed with the opf, but that seemed to make things worse. I finally just transferred all the files to a new EPUB, but reordering a bunch of files is tedious.

[Hitch]

Originally Posted by KevinH

Or remove the uuid dc:identifier and the content.opf will create a new one before saving it

Updated: whoops! This only works when the epub in question has obfuscated fonts!

May inquiring minds ask why that is?

So you would have to edit/add the bookid dc:identifier metadata and make sure it matches what is used in the ncx..

Hitch

[KevinH]

It is because both official font obfuscation algorithms use the main book uuid identifier value in their obfuscation/deobfuscation process. So saving an epub and obfuscating fonts, will simply destroy the font files without a main book uuid dc:identifier.

[Hitch]

Originally Posted by KevinH

It is because both official font obfuscation algorithms use the main book uuid identifier value in their obfuscation/deobfuscation process. So saving an epub and obfuscating fonts, will simply destroy the font files without a main book uuid dc:identifier.

Duh, of course. I forget, as we never use font obfuscation; we subset.

Thanks for taking the time to respond.

Hitch

[Tex2002ans]

Originally Posted by Evil Overlord

I think I'll try the UUID-generator site. In the case where this came up, I did try a bunch of things to make Sigil generate a new UUID, but they didn't work (perhaps because I don't have obfuscated fonts). I messed with the opf, but that seemed to make things worse.

Or another method: Create a new EPUB and just copy over the UUID into the template EPUB's content.opf + toc.ncx.

Then you could keep your template EPUB as a base, and don't have to do all that file reordering.

Originally Posted by Evil Overlord

I finally just transferred all the files to a new EPUB, but reordering a bunch of files is tedious.

If you do this so often, you could also number your template files to keep them in sorted order when you "Add Existing Files":

00-cover.xhtml
01-titlepage.xhtml
02-copyright.xhtml
99-backmatter.xhtml

How many template files are we talking here?

[Turtle91]

Instead of using the "Add Existing Files" technique, I simply saved a template epub (with all of my default files) as "template.epub" and set my desktop shortcut to open that file. When it opens I "Save As" with the new name then add any other content.

[Turtle91]

It would be nice to have Sigil add a UUID if it is missing from the opf automagically...then I would just save my template without a UUID to force generation.

While I'm wishing... Is it possible to force a "Save As" when opening a specific file...such as one named "Template.epub" or "*.tmp" or somesuch??

[slowsmile]

@Evil Overlord...Try the following if you want a new OPF uuid:

* Load your epub template file into Sigil
* Go to the OPF file and delete the "urn:uuid" part from the the uuid value.
* Then run the IDErrorCheck plugin from the Sigil Plugin Index.

The IDErrorCheck plugin will automatically fix and regenerate many incorrect ID errors in your epub -- including the uuids in the OPF and NCX files if they are incorrectly formatted. If you follow the above advice then this plugin should automatically give you a newly generated OPF uuid in the correct format.

And if the OPF uuid is incorrect then the OPF uuid will be replaced and the NCX uuid will also be replaced with the same uuid as the OPF(and vice versa) -- even though this is no longer an IDPF requirement(If the OPF uuid is different from the NCX uuid, Epupcheck no longer gives an error). I learned this from the Epubcheck developer blog after I requested that they fix the "colon" error msg problem some while ago.

[Doitsu]

I've recycled code from the ODT import plugin to create a simple epub template plugin and attached a beta version.

What the plugin does is add all files in its resources subfolder to the current epub. (It won't overwrite existing files with the same name, though.)
Simply install the plugin, display its resources folder in the file manager and copy all files that you want to add to the resources folder. (You can't use subfolders.)

To display the resources folder:

1. Press Windows+R (Run)
2. Copy and paste %USERPROFILE%\AppData\Local\sigil-ebook\sigil\plugins\EpubTemplate\resources and press Enter. (I've already added a dummy cover page for demonstration purposes.)

To run the plugin select Plugins > Edit > EpubTemplate.

[bravosx]

@Doitsu thank you for the ingenious plugin.

So far, I've been uploading my own templates each one by one. I inserted my xhtml file templates (cover, titlepage, chapters, endnotes) into the plugin as well as a style file and font. Now with one move I can put it all into Sigil.

I'm very happy.
bravosx