[1.9.20] css template issue

[byword]

I update 1.9.20(from 1.9.10) and test new features.

xhtml template(user-template2.xhtml and user-template3.xhtml)
and both of Preview custom css is working perfectly.

but user-template*.css(user-template2.css / user-template3.css) is not read when i creat new empty EPUB2 and EPUB3.

1. OS : Windows 11
2. Version : Sigil 1.9.20
3. Add user-template2.css and user-template2.css files to [..\sigil-ebook\sigil\] folder
4. restart sigil(css is not read/xhtml is working) and creat new empty EPUB(also css is not working but xhtnk is working)
* xhtml templates are working with epub2 and 3

am I missed something? or an error?

[DiapDealer]

The template is what appears when you right-click the css folder in Book Browser and select "Add Blank Stylesheet". Unlike the xhtml template, a blank Sigil epub has no css file.

[odamizu]

I must be doing something wrong.

I am on macOS Catalina and Sigil 1.9.20.

I have placed user-template2.xhtml and user-template2.css in User > Library > Application Support > sigil-ebook > sigil. Then restart Sigil.

Right-clicking in Book Browser to Add Blank HTML file and Add Blank Stylesheet simply create generic blank files, not my templates.

Help, please??

[DiapDealer]

Do you see your user-template*.(xhtml|css) files when you click the "Open Preferences Location" button in Sigil's preferences?

[KevinH]

on macOS, for me that is:

/Users/kbhend/Library/Application Support/sigil-ebook/sigil

You would need to replace "kbhend" with your own userid.

[odamizu]

Originally Posted by DiapDealer

Do you see your user-template*.(xhtml|css) files when you click the "Open Preferences Location" button in Sigil's preferences?

Yes

Originally Posted by KevinH

on macOS, for me that is:

/Users/kbhend/Library/Application Support/sigil-ebook/sigil

You would need to replace "kbhend" with your own userid.

Yes, sorry, when I write "User > Library" I do mean "Users > username > Library".

Now this is interesting. I just deleted my entire /sigil-ebook/sigil folder to do a clean install and now it works. So clearly something in my pre-existing folder from 1.9.10 was preventing this from working.

I will play with this some more later tonight to see if I can figure out what it is. Will keep you posted.

[byword]

Originally Posted by DiapDealer

The template is what appears when you right-click the css folder in Book Browser and select "Add Blank Stylesheet". Unlike the xhtml template, a blank Sigil epub has no css file.

I understand and it is working!
Thank you!

[KevinH]

I think Sigil looks for those files when a Main Window is first opened. So if you had Sigil-1.9.20 running with one or more Windows open before you added them, those already open windows would not know to look for any templates. Opening a new Main Window should make them work, as should exiting fully out of Sigil then starting it back up.

Originally Posted by odamizu

Yes



Yes, sorry, when I write "User > Library" I do mean "Users > username > Library".

Now this is interesting. I just deleted my entire /sigil-ebook/sigil folder to do a clean install and now it works. So clearly something in my pre-existing folder from 1.9.10 was preventing this from working.

I will play with this some more later tonight to see if I can figure out what it is. Will keep you posted.

[odamizu]

Originally Posted by KevinH

I think Sigil looks for those files when a Main Window is first opened. So if you had Sigil-1.9.20 running with one or more Windows open before you added them, those already open windows would not know to look for any templates. Opening a new Main Window should make them work, as should exiting fully out of Sigil then starting it back up.

After adding the template files, I exited fully out of Sigil then started it back up. I tried this multiple times, so that's not it.

I played around with this, and interestingly, for me at least, the problem only occurs when I'm working in EPUB3 (which I do almost exclusively, whether creating new epub or editing existing epub). When I create a new EPUB2, the templates work fine. This is with both a clean install and with my pre-existing Sigil preference folder. (I believe the reason it worked when I initially did a clean install is because clean install defaults to EPUB2.)

This seems odd to me, as I figure most testers are working with EPUB3. Am I the only one where the templates only work with EPUB2 and don't work with EPUB3?

[DiapDealer]

I can't see any difference on Windows or Linux. It all works as it should regardless of whether it's an epub2 or epub3--new or existing--and regardless of the default epub version setting.

I can't see anything in the code that would make it behave differently on macOS, but Kevin's the expert there.

[KevinH]

It is all platform agnostic code. It works in my macOS.

This is strange.

HTMLResource *Book::CreateEmptyHTMLFile(const QString &folderpath)
{
    HTMLResource *html_resource = CreateNewHTMLFile(folderpath);
    QString version = html_resource->GetEpubVersion();
    QString data;
    QString template_path;
    if (version.startsWith('2')) {
        template_path = Utility::DefinePrefsDir() + "/" + "user-template2.xhtml";
        data = EMPTY_HTML_FILE;
    } else {
        template_path = Utility::DefinePrefsDir() + "/" + "user-template3.xhtml";
        data = EMPTY_HTML5_FILE;
    }
    if (QFile::exists(template_path)) {
        data = CleanSource::Mend(Utility::ReadUnicodeTextFile(template_path), version);
    }
    html_resource->SetText(data);
    SetModified(true);
    return html_resource;
}

and

CSSResource *Book::CreateEmptyCSSFile(const QString &folderpath)
{
    TempFolder tempfolder;
    QString fullfilepath = tempfolder.GetPath() + "/" + m_Mainfolder->GetUniqueFilenameVersion(FIRST_CSS_NAME);
    Utility::WriteUnicodeTextFile("", fullfilepath);
    Resource * resource = m_Mainfolder->AddContentFileToFolder(fullfilepath,
                                                               true,
                                                               "text/css",
                                                               QString(),
                                                               folderpath);
    CSSResource *css_resource = qobject_cast<CSSResource *>(resource);
    QString version = css_resource->GetEpubVersion();
    QString data = "";
    QString template_path;
    if (version.startsWith('2')) {
        template_path = Utility::DefinePrefsDir() + "/" + "user-template2.css";
    } else {
        template_path = Utility::DefinePrefsDir() + "/" + "user-template3.css";
    }
    if (QFile::exists(template_path)) {
        data = Utility::ReadUnicodeTextFile(template_path);
    }
    css_resource->SetText(data);
    SetModified(true);
    return css_resource;
}

So long as you used the correct file names it should work.

For epub2:

user-template2.xhtml
user-template2.css

and for epub3:

user-template3.xhtml
user-template3.css

[CubGeek]

Originally Posted by odamizu

Am I the only one where the templates only work with EPUB2 and don't work with EPUB3?

Windows 10 (21H2)
Sigil 1.9.20

I have Sigil set in my preferences to default to EPUB3. I opened the Sigil Preferences directory through the button in the preferences dialog, then closed Sigil. I then created a "user-template3.css" and "user-template3.xhtml" into that same directory, using Notepad++. The CSS has a couple of basic entries, and the XHTML file has a basic framework with a couple paragraphs of "Lorem ipsum" content.

When I start Sigil, the user-template3.xhtml is automatically loaded and shown as the "OEBPS/Text/Section0001.xhtml" file in the Book Browser. When I right-click the Styles directory and select Add Blank Stylesheet, the user-template3.css is loaded as the "OEBPS/Styles/Style0001.css" file.


[Edit] I just tried the same process for EPUB2 (user-template2.*) with a couple changes so I could easily tell if they were the correct files, and when I had Sigil switch to a new EPUB2 document, the xhtml file was loaded as expected as was the CSS file for a new stylesheet. [/Edit]

[KevinH]

And fwiw, If you want to add more templates at the same time there is a Template plugin that allows loading an entire template epub at the same time while modding the book id as needed.

[odamizu]

Originally Posted by KevinH

... So long as you used the correct file names it should work.

For epub2:

user-template2.xhtml
user-template2.css

and for epub3:

user-template3.xhtml
user-template3.css

Ha! I knew I was doing something stupid.

From the ChangeLog ("add ability for a user-template*.xhtml and user-template*.css") I thought the * was a true wildcard and you could append anything to "user-template". I didn't realize you had to use 2 and 3 specifically and exclusively, and 2 and 3 referred to epub2 and epub3. So I was testing with user-template2.css and user-template2.xhtml, so of course it only worked with epub2.

Now that I've changed it to user-template3.css/xhtml, it works

I'll do a pull request to add this to the User Guide in the next few days.

As always, thank you @KevinH and @DiapDealer for the new release. Sigil is awesome

[KevinH]

Good to know. Yes, user's guide needs to be updated and any help with that is always welcome!