Sigil-1.5.0 Beta Released

[DiapDealer]

Sigil-1.5.0 Beta

Sigil-1.5.0 Beta represents a mix of bug fixes and new features for both epub2 and epub3 users.
Due to large internal changes in the Sigil codebase, this release should be considered Beta (non-production) ready.

This build of Sigil has passed all of our primary tests and appears to be stable but the feature set of Sigil has grown so large that no single person uses it the same way nor exercises all of the code.

So we need your help to track down any remaining issues, especially related to the new features and workings made to Code View, the Metadata Editor, and our new CSS parser being used to identify unused CSS Selectors.


New Features:

• Can now handle single xhtml file sizes over 2megabytes in size via its own URL Schemehandler
• Will now highlight matched open close tag pairs while editing in Code View
• Delete open close tag pairs (Remove Tag Pair)
• Default selection of text for basic CodeView formatting including bold, italic, etc based on cursor position
• Double-click (and shift double-click) on a tag to select tag contents (including tag)
• Expanded split on Sigil Split Marker capabilities to work better with nested tags
• Added a new C++ CSS Parser and Query engine that works with Sigil's version of Gumbo
• The Reports tool for "CSS Selectors" now lists all CSS selectors not just classes
• The "Delete Unused Styles" tool now handles all unused CSS Selectors not just classes
• The Reports for "CSS Selectors" and "Delete Unused Selectors" now handle selectors in XHTML Style tags
• Added ability to load text and csv files to Group Saved Searches to automate lists of replacements
• Reworked the Metadata Editor to be much more Human Readable with tooltips to show xml tags
• Added semantic code to the descriptive field in Add Semantics as a learning aid (Thank You BeckyEbook!)
• Checkpoint ManageRepos now has the ability to sort the repo table by any column (Thank You BeckyEbook!)
• The Sigil User Guide has be completely reworked to bring it to Sigil 1.5.0+ levels

Bug Fixes:

• Fix issue with custom ncx names in non-standard empty epub layouts
• Fix Import Text to properly add ncx if missing for epub2
• Fix issue with "Delete Unused Styles" not properly detecting all used selectors
• Fix issues with repeated use of Mend and Prettify on bare text in structural tags
• Fix extra line issue with Link to Stylesheet (Thank you BeckyEBook!)
• Fix bug in id assignment in EPUB3 Metadata editor
• Fix bug in trailing slash in Move To Folder paths
• Fix bug in spelling of Columbia->Colombia in Languages (Thank you Tex2002ans!)
• Fix bug in Clip Editor pasting of multiple clips
• Fix bug in PerformCSSUpdates related to quoted string in content: values
• Fix bug related to iframe handling when loading Preview
• Fix typos in XMLEntities descriptions (Thank you BeckEbook!)
• Fix numeric table alignment to align right in multiple tables (Thank you BeckyEbook!)
• Fix bug in Add Existing not properly using QProgressDialog for long import
• Removed long deprecated and now invalid use of "altlang" in EPUB3 Metadata Editor

---------------------------------------------------------------------------

Please check the Sigil Wiki for important Sigil support links, additional resource downloads, and platform-specific trouble-shooting tips/requirements.

Mac users should still download and install ActiveState's ActiveTcl Community Edition to utilize plugins that use Tk/Tcl GUIs. More here.
Mac users should also check out the wiki entry on the New Release File Format

The latest Sigil user guide can always be downloaded from its own repository.

PGP Fingerprint

The binary downloads (and source) can be found as assets at the bottom of The Sigil Github Release page.

[DiapDealer]

Post reserved for future use.

[odamizu]

Exciting! Thanks!

[democrite]

Nice.

If it is ok to request something that I hope you will consider and may include, either with the upcoming version, or later, I have found the new error message upon EPUB open with possible errors a bit confusing.

There are times when I edit an epub outside of Sigil and may introduce syntax errors that may possibly lead to data loss as mentioned by Sigil. Then there are more frequent times when I open a commercial EPUB in Sigil and the possible fixes are perhaps only metadata such as DOCTYPE, missing head elements, etc. Generally if I am making an EPUB myself, I I don't mind running epubcheck before the next opening with Sigil in case I messed up something. In the case of editing commercial epubs, it'd be nice to not to have run epubcheck each time before first open with Sigil to verify it is ok. More detail of the errors would be nice and I think help avoid potential data loss and save effort of verifying the EPUB when it is unneeded.

[exaltedwombat]

Windows 10 and/or Edge is trying very hard to protect me from installing this version!

[un_pogaz]

Originally Posted by exaltedwombat

Windows 10 and/or Edge is trying very hard to protect me from installing this version!

Normal at the start of each version. Retry now, they should be less annoying (10-20 minute and it's good).


Oh damn, the highlighting of the tags is so nice and will change my life.
Thanks you

Bug repport:
1) Display the characters escapes directly in the ToC editor (%20, %5B, %5D...)

2) Files with "&" in their name are excluded and deleted

3) ePub2 the property "Scheme" can not be customized (fixed and defined list) [image 1].

4) ePub2 impossible to change the value of a name attribute for the custom elements

5) ePub3 adding the metadata "Belongs to a Collection" should preemptively put the property "Type of collection" and "Position in the group" to facilitate editing (and preferably 2 metadata: one for the series and one for the collection/set)

6) ePub3 the very long custom element (several lines like those created by Calibre) are unreadable and impossible to modify [image 2]

7) impossible to select tag name, a attribute or the value of an attribute with double-click (over-ride by "select tag content" behavior)
I propose to reduce the behavior only when you Maj-Double-Click

Probably other more discreet features that I rarely use... well, it's a beta, so it's almost normal.

[KevinH]

Thanks for the bug reports, but I am not sure what you exactly mean with them. Would you please add information explaining each one in detail?

It would help to know what is correct or expected against what you are seeing.

As for & in filename, unless it is % escaped in your opf it is will be unmanifested and therefore will not be loaded. That sounds like your manifest in the opf is incorrect on reading in the epub into Sigil. If so, you should probably file a bug report with whatever created this epub in the first place.

Also, using special characters in a filename is probably not a good idea for general acceptability.

Originally Posted by un_pogaz

Normal at the start of each version. Retry now, they should be less annoying (10-20 minute and it's good).


Oh damn, the highlighting of the tags is so nice and will change my life.
Thanks you

Bug repport:
1) Display the characters escapes directly in the ToC editor (%20, %5B, %5D...)

2) Files with "&" in their name are excluded and deleted

3) ePub2 the property "Scheme" can not be customized (fixed and defined list) [image 1].

4) ePub2 impossible to change the value of a name attribute for the custom elements

5) ePub3 adding the metadata "Belongs to a Collection" should preemptively put the property "Type of collection" and "Position in the group" to facilitate editing (and preferably 2 metadata: one for the series and one for the collection/set)

6) ePub3 the very long custom element (several lines like those created by Calibre) are unreadable and impossible to modify [image 2]

7) impossible to select tag name, a attribute or the value of an attribute with double-click (over-ride by "select tag content" behavior)
I propose to reduce the behavior only when you Maj-Double-Click

Probably other more discreet features that I rarely use... well, it's a beta, so it's almost normal.

[KevinH]

For your 6. that is json, not css or xhtml. Nor is it xml. Exactly what is a "custom element" and if this is metadata, then does it even belong inside the opf?

For your 7, just drag to highlight. Shift Double-click has already been defined. That is the trade off made when that feature was added. (Is that what you meant by Maj Double Click?).

[Doitsu]

Originally Posted by un_pogaz

2) Files with "&" in their name are excluded and deleted

I was able to reproduce this issue with a file that was originally created with Calibre. If you add an ampersand to a file name in Calibre, it'll escape it as & instead of %26.

Apparently, the ampersand and the semicolon in & are escaped by Sigil and the file isn't found:

<item id="test.xhtml" href="Text/%26amp%3Btest.xhtml" media-type="application/xhtml+xml"/>

Originally Posted by un_pogaz

6) ePub3 the very long custom element (several lines like those created by Calibre) are unreadable and impossible to modify [image 2]

AFAIK, Calibre will sometimes add very long JSON-based metadata entries. I couldn't find an example, because I usually remove these entries. Hopefully, un_pogaz will provide an example.

[KevinH]

Well the Sigil Metadata Editor will never support editing custom metadata full of json in the editor itself. For specialized things like that people will need to directly edit the opf and be careful to properly escape things themselves.

[KevinH]

For your 5., that is an enhancement request not a bug, but it is a good idea and I can add something along those lines for Sigil 1.6.

[DiapDealer]

is Image #2 an example of an "unreadable", JSON entry? Seems pretty readable to me.

But at far as editing goes: at some point, those who wish to use custom schemes, and embed formatted JSON data in metadata values might have to get their hands dirty and edit the opf file manually. Sigil's not going to provide a gui feature to be able to easily edit calibre's proprietary json format used to support custom columns, categories, and collections in calibre's library view.

[KevinH]

I simply can not believe calibre's quality check approves of using an "&" in a file name inside an epub!

Even so urls/uris are supposed to be % encoded not xml escaped. So unless Kovid can point to the epub spec where "&" chars are supposed to xml escaped in urls or uri's in the opf, I consider this a bug in calibre not Sigil.

An & is not a legal char in a uri/url filename or path and you can not xml escape an & without using another &!

percent encoding of spaces, &, #, etc is how the spec says to deal with these chars.

That said, I could try to xml unquote the filename before % decoding but I think that will probably open a kettle of fish for something that is simply not a good idea at all.

Sorry but I am going to need to see where in the opf spec it says you can do that. It should have been % encoded and then no xml quoting or unquoting would be needed.

To workaround this, unzip the epub and use AddExisting to add the missing xhtml files. Sigil should properly % encode these when adding them to the opf.

Originally Posted by Doitsu

I was able to reproduce this issue with a file that was originally created with Calibre. If you add an ampersand to a file name in Calibre, it'll escape it as & instead of %26.

Apparently, the ampersand and the semicolon in & are escaped by Sigil and the file isn't found:

<item id="test.xhtml" href="Text/%26amp%3Btest.xhtml" media-type="application/xhtml+xml"/>

AFAIK, Calibre will sometimes add very long JSON-based metadata entries. I couldn't find an example, because I usually remove these entries. Hopefully, un_pogaz will provide an example.

[KevinH]

For your 3., agreed but unrecognized dc:identifier schemes are not going to be supported in the MetaData Editor. Especially since for EPUB3, the scheme is no longer recommended and instead a urn: based prefix is added to the identifier.

For custom things like that, you will have to edit in the opf being careful to properly add any needed prefix definitions if needed.

Edit: but if there is a popular dc:identifier scheme that is not already in the list of recognized lists, I could add it to the list easily.

Edit2:
Looking at that image you posted, that dc:identifier is a uuid. It has nothing in particular to do with Calibre per se. Any software can generate a random uuid identifier. The scheme here should be UUID.

[KevinH]

For your 1., I still do not understand what the issue is here? What exactly are you asking to be fixed or changed? A specific example would help clear things up.

Thanks,

Kevin