Sigil

Sigil-1.3.0

Sigil-1.3.0 represents a mix of bug fixes and new features for both epub2 and epub3 users.

Windows users please note that the installer will now allow Sigil to be installed for the current user only if desired. The installation of the included Visual Studio C++ runtime, however, will always require administrative privileges. You can provide those credentials for the runtime install portion only (if you install Sigil for the current user). The user can also skip the runtime check/install entirely if they desire. If they do so, however, it will be up to them (or their administrator) to make sure the proper Visual Studio C++ runtime is installed. Because of these changes, it recommended that Windows users uninstall the previous version of Sigil before installing this one. No settings, preferences, or plugins (or their configurations) will be lost by doing so.

New Features (since the 1.2.0 release):

• Added FontTab to show a specific font by double-clicking in BookBrowser
• Added Index Toolbar
• Windows/macOS release build updated to Qt 5.12.9 with added bug fixes
• Windows/macOS release build updated to Python 3.8.3
• Added increased protection against evil epubs manipulating file: urls
• Changes to support building with Visual Studio 2019 on Windows
• Improved Windows Installer and handling of C++ runtime libraries
• Updated Build instructions for MacOS, Windows, and Linux

Bug Fixes (since the 1.2.0 release):

• Reorganized the source code to add a Widgets folder to reduce code duplication
• Fixed spelling mistakes in MetaEditor user interface and xmlsanitycheck error messages
• Fixed mistakes handling font files (and other files) whose names start with a "." on macOS/Linux
• Improved embedded python error messages
• Improved some error messages on epub load
• Fix TabConnections to properly handle the new FontTab tabs
• grew Preferences Colour widths to better handle non-English colour names (Thanks BeckyEbook)
• Fixed bug in handling missing local links when using Add Existing ...
• Removed all python2 remanants from the Sigil plugin and pythonlib code
• If "Mend on Open" set, better handle import of huge file of of run-on lines
• Bug fix for css url updating
• Fix bug that prevented css updates from being shown in Preview without reload
• Fix gcc8 build warnings where possible
• Prevent BookBrowser's Rename and RERename from using URI delimiters ("#",etc) in file names

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

Mainly a Linux source-only release to handle an issue with the dulwich Python module (required for the new Sigil checkpointing feature) on systems with a Python 3 version less than 3.8.0.

Sigil-1.2.0

Sigil-1.2.0 represents a mix of bug fixes and new features for both epub2 and epub3 users.

New Features (since the 1.1.0 release):

• Provide a tweak setting to adjust drag distance for Windows & Linux
• Added YesToAll and NoToAll options for replacing images via Add Existing...
• Highdpi and uifont setting information is now available to Sigil's plugins
• Add a Checkpoint feature to Sigil for fast versioned saves to git repositories
• add ability to easily create a Checkpoint (stored via a local git repository)
  • add ability to see the changes between the current epub and any earlier Checkpoint
  • add ability to revert the entire epub back to an earlier Checkpoint
  • added ability to manage and delete Checkpoint repositories.

Bug Fixes (since the 1.1.0 release):

• Fix cosmetic file name issue when aborts file rename edits in BookBrowser
• Improve default drag-distance for BookBrowser for Windows & Linux
• Reduce required drag distance for macOS
• Fix index generation bug related to non-escaped text used in regular expressions
• Fix bug that caused lost class attributes when marking words for an index
• Guide to Landmark Semantic mappings have been extended to better cover "other.*" guide items
• Changed the removeDir() routine to better deal with Windows delete file issues.
• Updated Building on Windows docs
• Updated Building on MacOS docs
• Modified the codebase to use Ordered hashes/dictionaries throughout to prevent unneeded reordering in tag attribute order

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

Sigil-1.1.0

Sigil-1.1.0 represents a mix of bug fixes and new features for both epub2 and epub3 users. Some of the highlights for this release include:

Dark mode suport for Windows Linux and macOSX. Mac is the only one of the three platforms where Qt inherently supports the system-level dark mode.

A brand-new higher-contrast icon set for Sigil has been contributed by BeckyEbook. Thanks for all your contributions to this version @BeckyDTP !

Sigil's preference widgets have been redesigned to fit on smaller screens and to make room for future preference. Make sure you take a look around. Everything is still there (and a few things have been added), but some things have been regrouped and relocated.

Platform-specific Dark Mode details:

On Windows, darkmode is most commonly controlled by the darkmode settings in the latest version of Windows 10's settings. It won't work "on the fly" like many apps from the Windows Appstore, so you'll have to restart Sigil if you change your system settings to see the settings take effect. To override the system setting (or to enable dark mode on versions of Windows that don't officially have a dark mode), use the SIGIL_USES_DARK_MODE environnment variable (0 = off, anything else = on).

On Linux, Sigil has made changes to try and honor all platform themes that users define for their Qt apps on their desktop of choice. So theme managers like qt5ct or kvantum should work well with changing Sigil's look. There might be a bit of color/qss tweaking to do, but all-in-all, I've seen good results with a myriad of themes (dark and light). If you'd like to opt-in to Sigil's own included dark palette, set the FORCE_SIGIL_DARKMODE_PALETTE environment variable before launching Sigil. That will cause Sigil to ignore platform themes/overrides and to use the same dark palette that Windows uses.

On macOSX, Dark mode should just work. Qt has added a lot of inherent support for Mac's dark mode and Sigil has incorporated that support. Even on-the-fly time-of-day changes should work with Sigil.

New Features (since the 1.0.0 release):

• Added Support for Dark Mode for Windows, Linux and macOSX (Thanks BeckyEbook!)
• Added new icons that work well under both Light and Dark modes (Thanks BeckyEbook)
• Added ability to use Dark Mode for Preview (controlled by Preferences)
• Added Zoom Keys Ctrl +/- support to the Inspector (for improved Accessibility)
• Added support for a second Clip bar with up to 20 additional clips
• Select Special Character Dialog now support scrollbars
• Guide and Nav titles are now translated into ebook language (if translations available)
• All Report Names have been shortened to allow larger font sizes for better Accessibility
• Added improved contrast icons (Thank you BeckyEbook!)
• Completely reworked all Sigil Preference Dialogs to make them more screen/user friendly
• Added support for controlling Windows/Linux HighDPI settings
• Clips from the Clips QDockwidget window can now be used in CSS Tabs as well.
• The plugin interface has been extended to show current colorMode and primary colors

Bug Fixes (since the 1.0.0 release):

• Replaced deprecated QSignalMapper code with QActionGroups throughout Sigil's code base
  (still more work to do there)
• Fixed bug in "open-with" on macOSX that did not allow .app files to be selected
• Soft hyphens characters are now handled properly by Spellchecking [PR from BeckyEbook]
• Fixed bug in 'split at cursor" that created extra empty pages
• Fix bug in Insert Files from Disk
• Fixed same thread re-entrancy issues with tab creation / deletion code due to Qt signal/slot handling
• Fixed source code typos [PR from luzpaz]
• Fixed incorrect number of "times used" in Image Reports
• Fixed plugin font_iter() code to properly handle new Iana.org font media types
• Broken links are no longer changed during ImportHTML (Add Existing...) operations
• Cover svg image "vh" "vw" fixup code now properly handles empty headers on cover page
• GetBookpathByPathEnd() will now work properly and thereby better handle detection of file
  name conflicts during imports
• Better handle file name info from Validation plugins
• Inserting Links now creates proper links for top of page of the same file
• Fix ImportHTML when creating a new book to properly add an NCX if needed
• Include official QT backported fixes to Qt 5.12.6 to make it more stable
• The nav will now properly handle internal links to top of page of the nav itself
• harden lxml xml processing with resolve_entities set to false for improved security

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

Sigil-1.0.0 represents a major milestone in Sigil's history. The requirement that all epubs must be restructured to meet Sigil's long-held standard has finally been lifted. Users can still manually choose to restructure epubs to the old Sigil standards if they choose, but it will no longer be done automatically upon opening. Please read the following notes carefully to avoid confusion.

The major changes since Sigil-0.9.18 include the following:

• Upon initial load, the epub structure that exists will be loaded and kept in its "as-is" state, moving and renaming nothing
• The BookBrowser will still show the Text, Images, Styles, Fonts, Audio, Video, and Misc "folders" but these are now "virtual folders" that simply organize the existing resources by type but do not restrict their actual location within the epub.
• A new Preferences setting has been added to the Appearance Preferences that will determine if the book folder relative path will be shown in the BookBrowser or its shorter unique name (filename) will be used instead. In either case, the BookBrowser tooltips will always show the file's true book folder relative path. Duplicate file names (in different subfolders) will always show the longer path to be able to differentiate between them regardless of the new Appearance Preference.
• A Tools menu item has been added to standardize any epub already loaded to Sigil's old structure
• A Tools menu item has been added to allow a user to design a custom "empty" epub layout
• A "Move" context menu item has been added to BookBrowser to enable moving of resources to where you want them to be.
• A "Rename" context menu item has been added to BookBrowser to enable renaming of the NCX and OPF resources.
• The python plugin interface has been extended to support all of this as documented in the new Sigil_Plugin_Framework_rev12.epub and online at MobileRead in our Plugin Development thread.

Please note, the design goal of Sigil 1.0.0 was to make minimal changes for users and ebook developers that still want to use Sigil as they did. The new Preference setting defaults to showing only the filename as before, and the default empty epub for creating new epubs is the same as before. The interface and functionality should stay almost exactly the same. Loading any epub previously saved by Sigil will still work exactly as before. Only editing new epubs that are in non-standard form will necessitate a use of the new Tool menu (see the fourth item above) to standardize it.

Bug Fixes (since the 0.9.991 Pre-release):

• All bugs reported in alpha release have been fixed.
  Special thanks to Vroni, BeckyEBook, Doitsu, Odamizu,
  Un_Pogaz, snarkophilus, and many others who ran tests and reported bugs.
• Fix for crash on macOS opening Preferences following New MainWindow
• Workaround Qt bug in restoreState after maximize with Find and Replace open
• Fix logic to identify and store window geometry when normal (not maximized)
• Fix handling of plugin dialog being closed or aborted / cancelled
• Prevent Preview timer related crashes on closing MainWindow on macOS
• Update and harden media types recognition
• Use non-native QFileDialogs on macOS to workaround Qt bugs
• Fix crash of fast Tab closing on all platforms
• Prevent whitespace inside code tags from being changed when prettifying
• replace case change "text icon" with actual sizable icon (Thank you BeckyEbook)

New Features (since the 0.9.991 Pre-release):

• Add Load/Save capability for the Custom Empty Epub Layout Designer
• Large speedups in Reports using QtConcurrent
• Speedups in Spellcheck Dialog sorting
• Add File Name to Preview Window title
• Add Regular Expression File Renamer to BookBrowser context menu
• Mend on Open or Save only touch/repair non-wellformed files
• Re-enable Drag and Drop of Tabs
• Add menus/icons for "New ePub2" and "New ePub3" to ease creation of empty epubs (icons courtesy of BeckyEbook)
• Extend ePub2 Guide Semantics to include many of the "other.*" codes common to ePub3 as well

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

Announcing Sigil-0.9.991 (pre Sigil-1.0) Alpha Release

Before Sigil 1.0 can be released, we felt it was very important to remove the restriction that all epubs must be in Sigil standard form which included one OEBPS folder, specific names for the OPF, and NCX, only one folder for each type of resource (Text, Images, etc.).

Therefore, over the last two months, we have had to tear out much of the internals of Sigil to teach it to not standardize epubs on initial load, not to rename the OPF, NCX, not to move files to our specific folders, etc. Then we had to teach Sigil how to properly work with files in any structure or locations, how to build the correct links between them. This included extending the Sigil plugin interface appropriately.

To accomplish this over 4000 lines of code were added and over 2000 were deleted, touching almost every file in Sigil. All of this work has been very disruptive with the potential for lots of breakage and new bugs being introduced.

Special thanks must be given to both BeckyEbook and Doitsu for regularly building and testing the changes as they were being made and reporting back any breakage or issues they found and providing feedback on ideas. Without their hard volunteer effort, Sigil would be in a much much worse condition.

The work on Sigil-1.0 has now stabilized, and it is now ready for additional volunteers and testers to try and break it so that any final nits or issues can be tracked down and fixed before the upcoming Sigil 1.0 release.

The main changes include the following:

1. Upon initial load, the epub structure that exists will be loaded and kept in its "as-is" state, moving and renaming nothing
2. The BookBrowser will still show the Text, Images, Styles, Fonts, Audio, Video, and Misc "folders" but these are now "virtual folders" that simply organize the existing resources by type but do not restrict their actual location within the epub.
3. A new Preferences setting has been added to the Appearance Preferences that will determine if the book folder relative path will be shown in the BookBrowser or its shorter unique name (filename) will be used instead. In either case, the BookBrowser tooltips will always show the file's true book folder relative path. Duplicate file names (in different subfolders) will always show the longer path to be able to differentiate between them regardless of the new Appearance Preference.
4. A Tools menu item has been added to standardize any epub already loaded to Sigil's old structure
5. A Tools menu item has been added to allow a user to design a custom "empty" epub layout
6. A "Move" context menu item has been added to BookBrowser to enable moving of resources to where you want them to be.
7. A "Rename" context menu item has been added to BookBrowser to enable renaming of the NCX and OPF resources.
8. The python plugin interface has been extended to support all of this as documented in the new Sigil_Plugin_Framework_rev12.epub and online at MobileRead in our Plugin Development thread.

Additional bug fixes include:

• handle javascript location.href style in Preview
• use CaseInsensitive sort in Plugins menu (Thank you BeckDTP)
• use Locale aware sort routines for AddMetadata, and MetaData Names (Thankyou Doitsu)
• recognize x-font-otf style media types
• recognize vnd.adobe.page-template+xml media type
• recognize webp images media type
• improve updating of smil xml files when moved
• preserve whitespace inside the code element when prettifying
• try again to prevent timer events during MainWindow close that causes random crashes on exit on macOS
• fix svg cover images to use 100vh and 100vx in Preview

Please note, the design goal of this project was to make minimal changes for users and ebook developers that still want to use Sigil as they did. The new Preference setting defaults to showing only the filename as before, and the default empty epub for creating new epubs is the same as before. The interface and functionality should stay almost exactly the same. Loading any epub previously saved by Sigil will still work exactly as before. Only editing new epubs that are in non-standard form will necessitate a use of the new Tool menu (see # 4 above) to standardize it.

Call For Feedback, Testing, Plugin Developers, etc...

So we really need your help to test Sigil to make sure we have not broken anything and to provide feedback on the new features.

This release will also serve to allow Plugin Developers to test their plugins and make any changes needed to make sure their plugins will still work as expected.

So please take a minute to download Sigil-0.9.991 and test it as you would use earlier versions of Sigil, reporting back on MobileRead or via our GitHub site any bugs you find with instructions on how to recreate them. This is especially true of some of Sigil's more advanced features such as HTML TOC, Index generation, Merging and Splitting of Files, Reports, movement of resources, and any other feature of Sigil you would normally use on a regular basis. Though we're not going to ignore any reported issues, we're asking that you try to limit your reports to broken functionality or incorrect behavior. Cosmetic issues and minor inconveniences (with easy workarounds) can be dealt with later.

Note: Sigil-0.9.991 should not be considered a "production-ready" release. It is being made available to make sure our upcoming Sigil 1.0 release is as bug free and stable as possible.

Sigil-0.9.18 represents a mix of new features and bug fixes.

Bug Fixes:

• fix bug in macOS that caused spurious warnings about missing file in the manifest
• hopefully fix macOS bug about launching files using open-with from Desktop
• make sure JQuery gets loaded before starting to use Preview javascript functions
• fix local links during split that incorrectly used target filename for internal link
• create GetEnvironmentVar to make access to environment variables more cross-platform
• fix macOS bug when hitting close on the title bar of MainWindow causing strange window behaviour
• hopefully fix macOS segfault on close by disabling Preview timer immediately
• fix Windows 7 issues when running batch (.bat) files via OpenExternally (open with)
• all error messages are now properly logged
• fix improperly disabled open-with menu in Image Tabs popup context menu
• removed use of Qt obsolete methods in About and Error Dialogs

New Features

• enable use of SIGIL_DEBUG_LOGFILE environment var to control saving debug output to a file
• properly update the ncx after merging xhtml files
• properly warn users if a multiple rendition epub (multiple OPF files) has been loaded
• make Sigil's external XHtml editor work to pass an OPF file (see PageEdit new features)
• Allow epub3 metadata editor to edit primary meta tags
• Replace buggy cssutils module used in plugins with our own drop-in replacement fork: css-parser
• Updated Mac, Windows, and Linux build documentation

Be aware that Sigil-0.9.18 no longer enforces the need for epub3 to have and support an NCX for the purposes of backward compatibility with epub2 reading systems. There are, however, built-in tools to allow users to add backward compatibility features such as the NCX to their epub3.

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.

Sigil-0.9.17 is primarily a bug fix release for bugs that were uncovered after our port to QtWebEngine.

Bug Fixes:

• fix missing python3 network certifications on macOS
• do not apply named entities in Preserve Entities to epub3 epubs
• fix build docs for macOS
• prevent FlowTab destructor race crash when opening a new book (Linux, Mac, Windows)
• fix suggestions for built-in en_US dictionary by adding "x" to the TRY list
• fix plugins adding and deleting ncx under epub3
• throw exception in plugins when epub2 tries to add or delete the ncx
• fix bad Warning message about missing nav.xhtml file that was not missing
• fix CodeView to Preview sync breakage due to minimize/restore
• fix CodeView to Preview sync breakage due to attempting to load the Preview before it
  finished loading the last update
• fix sigil_bs4 to work with latest python lxml 4.4.X in a backwards compatible manner
• fix missing Preview to CodeView sync on Qt versions 5.9.X and 5.10.X
• fix segfault on app close related to the PreviewWindow update timer firing at a bad time
• fix CodeView to Preview syncing loss caused by spurious load finished signals
• fix macOS specific bug that allowed multiple MainWindows to become tabs

New Features

• add a python3 plugin module navprocessor.py for plugin devs
• show Preview by default (tabified with TOC) for new installations of Sigil

Be aware that Sigil-0.9.17 no longer enforces the need for epub3 to have and support an NCX for the purposes of backward compatibility with epub2 reading systems. There are, however, built-in tools to allow users to add backward compatibility features such as the NCX to their epub3.

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.

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

The first Official Release of Sigil ported to QtWebEngine to replace QtWebKit. And yes ... Book View is still really gone. But the companion external editing application PageEdit is available for those who still need/want a similar functionality.

New Features

• added epub3 tool: Generate NCX/Guide for epub2 e-readers
• added epub3 tool: Remove NCX and Guide
• added right click on link in Preview copies url to clipboard
• added check mark indicator for current semantic set in AddSemantics dialog
• opf guide is no longer used/updated in epub3, unless new epub3 tool menu is used
• harden Sigil against maliciously crafted epub zip archives (aka zip-slip attacks)
• added bk.getnavid() to the plugin framework and navprocessor.py for plugin devs
• updated build documents to the latest Qt 5.12.3 and Python 3.7.2)

Bug Fixes

• add missing title tag to nav head to make epubcheck happy
• add dcterms:modified to empty epub 3 opf to keep epubcheck happy
• fix lost Preview-CodeView sync when internal links are followed in Preview
• fix macOS specific bug with newer versions of PIL (Pillow) used by plugins
• no longer link against unused Qt frameworks when building (thank you eli-schwartz!)
• prevent MS VC++ automatic reboots during Windows installs
• prevent user from changing semantics of the nav file itself (it must be set to "toc")
• fix bug that dropped nav from spine when HTML TOC created

Be aware that Sigil-0.9.16 no longer enforces the need for epub3 to have and support an NCX for the purposes of backward compatibility with epub2 reading systems. There are, however, built-in tools to allow users to add backward compatibility features such as the NCX to their epub3.

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.

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

A Beta Release of Sigil ported to QtWebEngine to replace QtWebKit

New Features

• ported to use QtWebEngine (based on Chromium) to replace QtWebkit
• QtWebEngine plugs many major memory leaks. Memory footprint should stay low to moderate.
• QtWebEngine has ongoing security and support patches from Qt/Google/Chromium
• removes the broken/deprecated BookView Editor that relied on QtWebKit
• created PageEdit app (that uses QtWebEngine) that replaces much BookView functionality
  (see https://github.com/Sigil-Ebook/PageEdit)
• allows the user to control use of javascript and remote access by epubs when editing
  to improve overall security
• adds action to launch one preferred external xhtml editor via shortcut or icon
  (can be used to fast launch PageEdit app or any other xhtml open-with editor)
• adds 5 more plugin quicklaunch buttons to main menu for a total of 10
  (with all new icons! Thanks so much Becky!)

It also includes all of the fixes and updates from Sigil-0.9.14.

Be aware that Sigil-0.9.15 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

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

This Sigil release is primarily to address performance issues and memory leaks, but there are a still some new features and other bug fixes as described below.

Bug Fixes

• flush all changes to disk before creating a Report so that files sizes are correct
• stop writing python bytecode to Program Files on Windows
• remember cover semantics if cover image replaced by Add Existing...
• fix issues with the Plugin Framework documentation epub
• more memory leaks plugged
• minor code cleanups

New Features

• updated to Qt 5.12.3 with Annulen Webkit 5.212 with extra QtCursor memory leak fixes
• updated to Python 3.7.2
• updated build docs for macOS, Linux and Windows
• build system now uses GNUInstallDirs to determine the best installation libdir on Linux
• updated desktop integration for Linux
• reduce PCRE cache size to help lower memory footprint
• improve mapping of hunspell dictionary names to actual language names (thanks BeckyDTP)
• add warning during import if unmanifested files exist in the epub zip archive
• no longer requires use of non-breaking space entities (or any entities at all!)
• special spaces are now visisble via syntax highlighting in CodeView
• dropping epubs on Sigil.app no longer opens an extra empty epub on macOS
• reload Preview only when needed to help prevent screen flicker and lower memory use
• enabled Windows automated builds using Apppveyor
• Windows releases now compiled with Visual Studio 2017
• characters in HTML files report now uses gumbo for speed
• allow user's custom plugin icons to survive a plugin update

Sigil 0.9.14 will mark the last version that uses QtWebKit, and will be the last version to support editing in BookView. More here.

Be aware that Sigil-0.9.14 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

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

NOTICE: If after installing Sigil v0.9.13 (or higher), Sigil is crashing, won't run correctly, or won't start at all, check out this wiki notice before filing a report or asking for assistance.

This Sigil release is primarily to address bugs introduced by the upgrade to Qt5.11.2 and Python 3.7 in the previous releases and to revert the conversion of Sigil ini files to the utf-8 character encoding.

Bug Fixes

• Revert change of INI encoding to utf-8 as QSettings very broken under utf-8 (commit 5484463)
• Ensure all url attributes in shape-outside properties in CSS stylesheets get updated (commit de7b09f)
• Workaround for lost cursor in qlineedit Qt bug (issue #398) (commit a8acab7)
• Workaround missing File New, Open, Quit menus in Mac menubar if windows closed (commit 660a8aa)
• Remove Icon from Tab for macOS only to workaround Qt bug (commit 5c91924)
• Plug some memory leaks (commits: 85f78d7, cb9b833, 614d601, bf2f2f4, ebfb613, 4qa8f33)
• Backport Qt 5.12alpha fix to prevent heap corruption due to qwidget next focus pointers (commit f5c7284)
• Plug macOS memory leaks when closing a main window (commit fbf9015)
• Put back quote in tag name bug fix lost in recent changes (commit ebd8c7c)
• Disable Netscape Plugins being used in BookView and Preview Window (commit 79314ea)
• Use custom version of qtwebkit with Qt 5.5 memory leak fix added back and no load plugins if disabled
  (see commits 94a28d7, 9f7ebba, and 4b968a9)

New Features

• Add filename to tab tooltip (commit 27f8db7)
• Clear memory caches when Preview changes to keep memory footprint smaller (commit 87b9247)
• Update to MathJax 2.75, adds support for mathml mlongdiv, mstack, mcarries (commit 568aba5)
• Reduce memory footprint by letting worker threads expire (commit c1ee7ea)
• Reduce memory footprint by properly setting web page caches (commit 9f07cbe)

Be aware that Sigil-0.9.13 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

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

This is a buggy version of Sigil. Don't use it. If you have good backups of your Sigil 0.9.10 (or earlier) preferences, roll back to Sigil 0.9.10 and restore your backed up preferences. If you don't have backups of your Sigil 0.9.10 (or earlier) preferences, roll back to Sigil 0.9.10 anyway and recreate your preferences as best you can from within Sigil's UI. Those preferences will be usable with the release of Sigil that follows 0.9.12.

This Sigil release is primarily to address bugs introduced by the upgrade to Qt5.11.2 and Python 3.7 in the previous release.

Bug Fixes

• fix typo in cssreformatter that caused errors with @ fontface (issue #394)
• workaround for qt bug affecting tab close buttons on Mac (commit f3b9399)
• fix Mac Qt5 plugin dylibs that macdeployqt broke in Sigil-0.9.11

Be aware that Sigil-0.9.12 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

Starting with Sigil-0.9.11, Sigil's ini preference files will be utf-8 encoded to more easily allow users to manually edit them. NOTE: before upgrading to Sigil-0.9.11, please make and save a backup of your preferences files. There is no issue with the conversion moving forward, but if, for whatever reason, you need to roll back to an earlier version of Sigil, utf-8 encoded unicode characters in your ini files will not work with earlier versions of Sigil. So please be safe and make a backup just in case.

The decision to move to utf-8 encoded preference files was reverted and will be back to normal starting with Sigil v0.9.13

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

This is a buggy version of Sigil. Don't use it. If you have good backups of your Sigil 0.9.10 (or earlier) preferences, roll back to Sigil 0.9.10 and restore your backed up preferences. If you don't have backups of your Sigil 0.9.10 (or earlier) preferences, roll back to Sigil 0.9.10 anyway and recreate your preferences as best you can from within Sigil's UI. Those preferences will be usable with the release of Sigil that follows 0.9.12.

Sigil-0.9.11

For the impatient, the installer files (and source) can be found as assets at the bottom of this Github Release page.

This Sigil release is a mix of bug fixes and new features for both epub2 and epub3 users. Some of the highlights for this release include:

Starting with Sigil-0.9.11, Sigil's ini preference files will be utf-8 encoded to more easily allow users to manually edit them. NOTE: before upgrading to Sigil-0.9.11, please make and save a backup of your preferences files. There is no issue with the conversion moving forward, but if, for whatever reason, you need to roll back to an earlier version of Sigil, utf-8 encoded unicode characters in your ini files will not work with earlier versions of Sigil. So please be safe and make a backup just in case.

The decision to move to utf-8 encoded preference files was reverted and will be back to normal starting with Sigil v0.9.13

The Windows and Mac installers have been updated to use Qt5.11.2 and Python 3.7.

Restore ability to click in the Preview window to reposition to the same point in Code View while keeping the ability to follow links in Preview.

Allow users to maintain up to 5 external programs per file type with the Open With feature.

Sigil 0.9.11+ no longer supports Windows Vista.

Sigil 0.9.11+ no longer supports macOS 10.9 and macOS 10.10. macOS upgrades are available for free directly from Apple.

The specific changes/additions follow...

Bug Fixes

• after mend and prettify - put cursor at enclosing tag if possible
• allow both links in Preview and clicking in Preview to reposition CV
• fix new cursor repositioning under new tab ala Spellcheck
• fix prettyprinting of the mark tag in gumbo and sigil_bs4
• fix crash when tagname illegally (for xhtml) includes single or double quotes
• fix crash in Reports for non-wellformed xhtml that was okay under html5
• fix deletion of multiple css files when Book View is open (Windows)
• fix bug in reformat CSS with media queries
• fix bug in closing some tabs needlessly when linking stylesheets
• fix crash bug in gumbo parser under very strange circumstances
• remove empty guide elements in epub2 opf as epubcheck now flags these
• fix issue with index generation reordering spine entries under certain conditions

New Features

• update official builds to use Qt 5.11.2 and Python 3.7
• update internal Python modules to use latest versions
• update Sigil's gumbo parser to fix all known bugs and greatly speedup parsing
• embed new project css_parser (fork of cssutils) as a python library to fix css parsing
• Sigil no longer attempts to upgrade the VC++ runtime on Windows. It only installs the
  bundled VC++ runtime if there is no compatible version already installed
• add support for internal but unmanifested opf metadata link resources under epub3
• extend "Open With" context menu to allow up to 5 external editors per resource type
• make format of all Sigil ini files to be utf-8 encoded to more easily allow user changes

Be aware that Sigil-0.9.11 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

Sigil-0.9.11 like its predecessors passed all of the following tests for epub3 support: iframe, img, audio, video , mathml, svg (except for svg support in the spine), javascript, and of course recognizing and allowing html5 specific tags like section, and etc. Sigil-0.9.11 also supports javascript based local-storage and display of embedded pdfs.

Download Location

The official location for downloading this Sigil release (and all official releases) is:

https://github.com/Sigil-Ebook/Sigil/releases/tag/0.9.11

The latest version of the Sigil User Guide can be downloaded from: https://github.com/Sigil-Ebook/sigil-user-guide/releases/latest

Downloading binaries from anyplace else is simply NOT a good idea as they could inject anything into their own downloads. After downloading, please verify the downloaded binary exactly matches what was originally posted by running an SHA 256 checksum on the file before installing it. See the file Sigil-0.9.11-CHECKSUMS.sha256.txt for the correct checksums for each file and instructions for how to calculate a SHA 256 Checksum for your download. The Mac OS X Package has also been code signed with my Apple Developer signature.

Windows Users

If your current version of Sigil is 0.9.6 or earlier, it's recommended (but not required) that you uninstall that version before installing 0.9.11. Some compiled Python files have had their file extentions changed (as well as the change to Python 3.7). As a result, there will be a lot of extraneous files left lying around if you just install the new over the old. It won't cause any functionality problems, but if disk space is at a premium, you may want to clean things up a bit. You can do this by uninstalling Sigil at any time (even after 0.9.11 is installed) and reinstalling. Doing so won't affect your any of your preferences, plugins, keyboard shortcuts, clips, saved searches, etc.

Linux Users

There are currently no official binary releases available for Linux on the Sigil Release page. Please check with your favorite distro's software repositories to see if they have Sigil for installation via your OS's package management system. If not, there are build instructions for compiling Sigil yourself in the source archive's docs directory: https://github.com/Sigil-Ebook/Sigil/tree/master/docs

Don't forget the FlightCrew plugin

Please note, the epub2 validator FlightCrew has been converted to a plugin for Sigil 0.8.900 and later.
This plugin has been updated for Sigil-0.9.3 (and later). It can be downloaded from the official Sigil-Ebook flightcrew repository if you have not already installed it.

https://github.com/Sigil-Ebook/flightcrew/releases/latest

Attention Mac OS X Users

Per the recommendation of www.python.org (see https://www.python.org/download/mac/tcltk/), due to bugs and the age of Apple's internal Tcl library, you should also download and install ActiveState's ActiveTcl Community Edition. To get the latest bug fixes, Sigil-0.9.11's embedded Python has been linked with version: Tcl 8.6.4.1

We may not redistribute this Package with Sigil due to ActiveState's binary non-redistribution policy.

So please, if you have not already done so download and install this version of ActiveState's Active Tcl Community Edition, until we get a chance to do our own build of Tcl 8.6.X from source for future releases. ActiveState is a primary contributor to www.python.org and a respected and trusted source for python and tcl/tk related binaries on both Windows and Mac OS X.

See: http://www.activestate.com/activetcl/downloads
Version: 8.6.4.1 or later 8.6.X release

Signed Source Archives and Git Tags

Starting with Sigil v0.9.9, the Git tags and source archives used for Sigil releases are signed with Doug Massay's PGP Key. His public key can be found and retrieved from any public key server. The fingerprint for his public key is: B5A5 6206 AB0F BC1A 24EF AB8A A166 D29A 8FCD AC63

Some Additional things

When you fire up Sigil for the very first time:

• navigate to the new General Preferences and select the default
  epub version you plan to work with (epub 2 or epub3) so that new
  empty ebooks start with the correct code.
• if you plan to work with epub3 epubs, you should change your
  PreserveEntities setting to use ONLY NUMERIC entities.
  For example use   for non-breaking spaces and etc.
• We strongly recommend enabling Mend On Open in your settings
  for best performance with Sigil.

Sigil-0.9.10

This Sigil release is a mix of bug fixes and new features for both epub2 and epub3 users. Some of the highlights for this release include:

Allow plugins to supply their own icon (plugin.png 48x48) for use on the Quick Launch Toolbar icons.

Allow users to add custom css rules to Preview/Book View by creating a file called "custom_preview_style.css" in the Sigil preferences folder.

The Sigil User Manual was updated to include the feature set consistent with Sigil v0.9.x. We have Tex2002ans to thank for this!

Many crashing scenarios were also addressed.

The specific changes/additions follow...

Bug Fixes

• Fix signal handling to prevent double launch of plugins immediately after plugin installed
• Fixed incorrect named entity tooltips for many of the Insert-> Special Characters
• Fixed lack of recognition of woff2 fonts inside Sigil and for plugins
• Fix segfault when .xml is first file in BookBrowser and add new html or split at cursor is invoked
• Fix bug that allowed multiple audio/video tabs of the same resource to be opened
• Fix plugin related bug when adding/removing last xhtml file
• Fix Text Direction setting inside body to use structural dir attribute under epub3
• Fix duplicate group-position property in epub3 MetaData Editor
• Use absolute path references when first opening Sigil with an ebook so that Open Recent works better
• Fix "issue" in handling self-closing script tags in head (similar issue that we had with self-closing title tags)
• Fix issue converting Qt Strings to their Python equivalent when outside the BMP
• Fix issue with trying to add existing html files when names clash due to case insensitive file systems
• Fix crash bug after styling text in BookView and immediately going to CodeView without moving cursor
• Fix crash bugs after deleting resources contained in a Report in the BookBrowser
• Fix bug that destroys nav if left in unparseable state by user even temporarily
• Fix bug that moved cursor to beginning of tag block when save is done in CodeView

New Features

• allow plugins to supply their own icon (plugin.png 48x48) for use on the Quick Launch Toolbar icons
• extend plugin interface to include the status of the epub inside Sigil (modified or saved)
• extend plugin interface to include the path to the saved epub file or the null string if never saved
• extend Insert->Special Characters to include both a Greek letter panel and a mathematical symbol panel
• add support for calibre:series and calibre:series_index to Metadata Editor for epub2
• add support for calibre:title_sort to Metadata Editor for epub2
• add support for clicking internal links in Preview to load the proper destination tab
• add support for loading Qt's base translation files if present. Allows buttons on native qt dialogs to
  be translated (Windows users may need to manually copy newer qtbase_xx.qm files to Sigil's translation
  directory if they didn't exist in Qt5.6.2)
• allow user to add custom css rules to Preview/Book View by creating a file called "custom_preview_style.css"
  in the Sigil preferences folder (not responsible for custom css and ebook css fighting with each other)

Be aware that Sigil-0.9.10 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

Sigil-0.9.10 like its predecessors passed all of the following tests for epub3 support: iframe, img, audio, video , mathml, svg (except for svg support in the spine), javascript, and of course recognizing and allowing html5 specific tags like section, and etc. Sigil-0.9.10 also supports javascript based local-storage and display of embedded pdfs.

Download Location

The official location for downloading this Sigil release (and all official releases) is:

https://github.com/Sigil-Ebook/Sigil/releases/tag/0.9.10

The latest version of the Sigil User Guide can be downloaded from: https://github.com/Sigil-Ebook/Sigil/raw/master/docs/Sigil_User_Guide.epub

Downloading binaries from anyplace else is simply NOT a good idea as they could inject anything into their own downloads. After downloading, please verify the downloaded binary exactly matches what was originally posted by running an SHA 256 checksum on the file before installing it. See the file Sigil-0.9.10-CHECKSUMS.sha256.txt for the correct checksums for each file and instructions for how to calculate a SHA 256 Checksum for your download. The Mac OS X Package has also been code signed with my Apple Developer signature.

Windows Users

If your current version of Sigil is 0.9.6 or earlier, it's recommended (but not required) that you uninstall that version before installing 0.9.10. Some compiled Python files have had their file extentions changed (as well as the change to Python 3.5). As a result, there will be a lot of extraneous files left lying around if you just install the new over the old. It won't cause any functionality problems, but if disk space is at a premium, you may want to clean things up a bit. You can do this by uninstalling Sigil at any time (even after 0.9.10 is installed) and reinstalling. Doing so won't affect your any of your preferences, plugins, keyboard shortcuts, clips, saved searches, etc.

Linux Users

There are currently no official binary releases available for Linux on the Sigil Release page. Please check with your favorite distro's software repositories to see if they have Sigil for installation via your OS's package management system. If not, there are build instructions for compiling Sigil yourself in the source archive's docs directory: https://github.com/Sigil-Ebook/Sigil/tree/master/docs

Don't forget the FlightCrew plugin

Please note, the epub2 validator FlightCrew has been converted to a plugin for Sigil 0.8.900 and later.
This plugin has been updated for Sigil-0.9.3 (and later). It can be downloaded from the official Sigil-Ebook flightcrew repository if you have not already installed it.

https://github.com/Sigil-Ebook/flightcrew/releases/tag/0.9.1

Attention Mac OS X Users

Per the recommendation of www.python.org (see https://www.python.org/download/mac/tcltk/), due to bugs and the age of Apple's internal Tcl library, you should also download and install ActiveState's ActiveTcl Community Edition. To get the latest bug fixes, Sigil-0.9.10's embedded Python has been linked with the very latest version: Tcl 8.6.4.1

We may not redistribute this Package with Sigil due to ActiveState's binary non-redistribution policy.

So please, if you have not already done so download and install this version of ActiveState's Active Tcl Community Edition, until we get a chance to do our own build of Tcl 8.6.4.1 from source for future releases. ActiveState is a primary contributor to www.python.org and a respected and trusted source for python and tcl/tk related binaries on both Windows and Mac OS X.

See: http://www.activestate.com/activetcl/downloads
Version: 8.6.4.1

Signed Source Archives and Git Tags

Starting with Sigil v0.9.9, the Git tags and source archives used for Sigil releases are signed with Doug Massay's PGP Key. His public key can be found and retrieved from any public key server. The fingerprint for his public key is: B5A5 6206 AB0F BC1A 24EF AB8A A166 D29A 8FCD AC63

Some Additional things

When you fire up Sigil for the very first time:

• navigate to the new General Preferences and select the default
  epub version you plan to work with (epub 2 or epub3) so that new
  empty ebooks start with the correct code.
• if you plan to work with epub3 epubs, you should change your
  PreserveEntities setting to use ONLY NUMERIC entities.
  For example use & # 1 6 0 ; for non-breaking spaces and etc.
• We strongly recommend enabling Mend On Open in your settings
  for best performance with Sigil.

Sigil-0.9.9

This Sigil release is a mix of bug fixes and new features for both epub2 and epub3 users. Some of the highlights for this release include:

Fixed the bug on Windows where smart right single quotes used for apostrophes couldn't be added properly added to a user word list. This one has been aroud for a while!

Ability to limit/disable clipboard history saving (a new General Preferences setting). Please note that the clipboard history feature will behave exactly as it always has while Sigil is running. Meaning that anything added to the clipboard while Sigil is running will be available for pasting. The new preference setting merely dictates how many entries (if any) get saved to the Sigil ini file when Sigil closes. Set it to zero to keep Sigil from saving any of the clipboard history to the ini file.

A new Spellcheck Dictionary Preferences setting that allows the user to include words with numbers in them.

Two new Quick Launch Icons for plugins were added to the main menu. There are now a total of five available.

The specific changes/additions follow.

Bug Fixes

• Add python_3.5_fixes3.patch to Python build and update build docs on OSX to fix missing symbols
• Fix crash caused by Preview holding pointer to user removed resource when front tab is non-html resource
• Fix crash in FlowTab destructor due to re-entering flowtab during Syntax Highlighting and signals
• Fix issue with file icons disappearing when reordering in Book Browser (commit ecb56b1f)
• Fix missing epub3 Manifest cover-image property setting/unsetting with BookBrowser
• Fix issue where cancelling the SaveAs dialog disconnected an existing epub from its saved path
• Fix assertion error in sigil-gumbo when handling extraneous script end tags
• Apply multiple fixes for gumbo from upstream
• Fix segfault in Split at Cursor when not an html file
• Make sure Add Cover tool properly handles existing manifest cover properties in EPUB3s
• Correct error dialog to say "Sigil may need to close."
• Prevent Images and Misc items from being dragged to the Text folder in Book Browser (commit 30bb96d)
• Fix Linux bug that prevents rich text from other programs being pasted into Book View (issue #320)
• Fix bug where index entries inside em and dfn tags were ignored during index generation
• Fix bug on Windows in spell checking when smart right single quotes are used for apostrophes
• Fix bug in simple well-formed check to handle generic xml processing instructions
• Fix bug in epub3 MetaEditor with title-type and collection-type properties
• Fix plugin code to prevent book href vs manifest id clashes
• Fix bug in Plugin Runner to allow it to delete non-manifested files properly
• Fix bug in SourceUpdates to handle properly handle css properties with multiple urls
• Fix bugs in well-formed check to better handle missing doctypes

New Features

• Add SIGIL_DISABLE_CURSOR_BLINK environment variable to disable text cursor to aid Accessibility on OSX
• Better use semantic information (guide types and Landmarks) to allow the user finer control of index generation
• Attempt to improve Metadata Editor placeholder text to help beginners
• Preview Window Title bar will now show height and width of the Preview Window
• Allow users to limit/disable clipboard history saving via General Preferences
• Convert br tags in header text to linebreaks for toc/ncx/nav generation routines
• Support spell checking of words with numbers controlled by Preference settings
• Add two additional Quick Lauch Icons for Plugins

Be aware that Sigil-0.9.9 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

Sigil-0.9.9 like its predecessors passed all of the following tests for epub3 support: iframe, img, audio, video , mathml, svg (except for svg support in the spine), javascript, and of course recognizing and allowing html5 specific tags like section, and etc. Sigil-0.9.9 also supports javascript based local-storage and display of embedded pdfs.

Download Location
The official location for downloading this Sigil release (and all official releases) is:

https://github.com/Sigil-Ebook/Sigil/releases/tag/0.9.9 (downloads found at the bottom)

The latest version of the Sigil User Guide can be downloaded from: https://github.com/Sigil-Ebook/Sigil/raw/master/docs/Sigil_User_Guide_0_7_2.epub

Downloading binaries from anyplace else is simply NOT a good idea as they could inject anything into their own downloads. After downloading, please verify the downloaded binary exactly matches what was originally posted by running an SHA 256 checksum on the file before installing it. See the file Sigil-0.9.9-CHECKSUMS.sha256.txt for the correct checksums for each file and instructions for how to calculate a SHA 256 Checksum for your download. The Mac OS X Package has also been code signed with my Apple Developer signature.

Windows Users
If your current version of Sigil is 0.9.6 or earlier, it's recommended (but not required) that you uninstall that version before installing 0.9.9. Some compiled Python files have had their file extentions changed (as well as the change to Python 3.5). As a result, there will be a lot of extraneous files left lying around if you just install the new over the old. It won't cause any functionality problems, but if disk space is at a premium, you may want to clean things up a bit. You can do this by uninstalling Sigil at any time (even after 0.9.9 is installed) and reinstalling. Doing so won't affect your any of your preferences, plugins, keyboard shortcuts, clips, saved searches, etc.

Linux Users
There are currently no official binary releases available for Linux on the Sigil Release page. Please check with your favorite distro's software repositories to see if they have Sigil for installation via your OS's package management system. If not, there are build instructions for compiling Sigil yourself in the source archive's docs directory: https://github.com/Sigil-Ebook/Sigil/tree/master/docs

Don't forget the FlightCrew plugin
Please note, the epub2 validator FlightCrew has been converted to a plugin for Sigil 0.8.900 and later.
This plugin has been updated for Sigil-0.9.3 (and later). It can be downloaded from the official Sigil-Ebook flightcrew repository if you have not already installed it.

https://github.com/Sigil-Ebook/flightcrew/releases/tag/0.9.1

Attention Mac OS X Users
Per the recommendation of www.python.org (see https://www.python.org/download/mac/tcltk/), due to bugs and the age of Apple's internal Tcl library, you should also download and install ActiveState's ActiveTcl Community Edition. To get the latest bug fixes, Sigil-0.9.9's embedded Python has been linked with the very latest version: Tcl 8.6.4.1

We may not redistribute this Package with Sigil due to ActiveState's binary non-redistribution policy.

So please, if you have not already done so download and install this version of ActiveState's Active Tcl Community Edition, until we get a chance to do our own build of Tcl 8.6.4.1 from source for future releases. ActiveState is a primary contributor to www.python.org and a respected and trusted source for python and tcl/tk related binaries on both Windows and Mac OS X.

See: http://www.activestate.com/activetcl/downloads
Version: 8.6.4.1

Some Additional things

When you fire up Sigil for the very first time:

• navigate to the new General Preferences and select the default
  epub version you plan to work with (epub 2 or epub3) so that new
  empty ebooks start with the correct code.
• if you plan to work with epub3 epubs, you should change your
  PreserveEntities setting to use ONLY NUMERIC entities.
  For example use & # 1 6 0 ; for non-breaking spaces and etc.
• We strongly recommend enabling Mend On Open in your settings
  for best performance with Sigil

Sigil-0.9.8

This Sigil release is a mix of bug fixes and new features for both epub2 and epub3 users. Some of the highlights for this release include:

PyQt5 support for plugins. The full-blown PyQt5 is not included with the Mac and Windows bundled Python, but the Core, Gui, Widget, and SVG bindings (and a few others) are available. PyQt5 should be able to be used to create much more robust plugin GUIs that are translatable and that match Sigil's Qt "look and feel".

A new "Menus" tab in the Appearances Preferences section has a slider to adjust the size of Sigil's main icons to your liking. This eliminates the need for setting the SIGIL_ICON_SCALE_FACTOR environment variable to achieve a similar effect. So those who were using that variable take notice.

The Windows directory structure has had a bit of an overhaul to eliminate the need for the duplication of some included DLLs and to accommodate PyQt5. The installer will be able to accommodate these changes (as well as test for Service Pack minimum requirements before the installation begins) with no manual intervention.

There was also an important fix for temp_folder issues on Windows systems that create a new system temp folder each login that made it into this release.

The specific changes/additions follow.

Bug Fixes

• Make sure when new empty epub3's are created that the toc does not use a doctype (Issue #250)
• Make GetUniqueFilenameVersion work even on Case-Insensitive filesystems (Issue #247)
• Properly urlencode/decode all hrefs in plugin's ResultXML in launcher/PluginRunner to prevent parse errors
• Enable Basic Cut Copy Paste Icons/Actions in OPF, NCX, XML, SVG, and other Misc Text Tabs
• Add proper detection for minimum service pack requirements in Windows installer
• Include workaround for bug in KDE Qt5 plugin on Linux that keep plugins from launching from menu
• Prevent splitting Section0001.xhtml (Split at Cursor) needlessly rewrite the file's manifest id with a uuid
• Fix issue where merging files when non-xhtml tabs were open was causing Python errors or crashes
• Fix segfault in Image Reports when deleting unused image files
• Fix bug in prettyprint_xhtml in sigil_bs4 (put back inadvertently dropped is_void_tag routine)
• Fix gumbo serialize to better handle injected newlines
• Harden bundled Python isolation on Windows and add subset of PyQt5 to bundled modules
• Harden plugin interface code to properly unquote/quote hrefs
• Stop Sigil from nagging about unsupported mimetypes when epubs with Adobe xpgt page-templates are opened
• Fix Book Browser highlighting issue when editable XML files from the "Misc" folder are opened
• Pull upstream bug fixes from google's gumbo parser for Sigil
• Force formatting buttons in BookView to generate inline-styled spans instead of "strike", "b", etc
• Fix bug from deprecated use of jquery $.browser.msie introduced when jQuery was updated
• Fix temp folder specification on Windows systems that delete the system temp folder for every login (Issue #285)
• Fix typos in metadata descriptions to allow better translations

New Features

• New preference setting (Appearance section) which allows user to adjust the size of the main menu icons
• Add manifest properties to Book Browser tooltips and to All Files Reports Widget for epub3
• Make Sigil's UI and spellchecker language settings available to plugins
• Add support for PyQt5 for plugin gui widgets
• Internal builds now use Qt 5.6.2 with Webkit added back
• Windows structural changes to eliminate file duplication and to accommodate PyQt5 requirements
• Update all build it yourself from source documentation for new requirements

Be aware that Sigil-0.9.8 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

Sigil-0.9.8 like its predecessors passed all of the following tests for epub3 support: iframe, img, audio, video , mathml, svg (except for svg support in the spine), javascript, and of course recognizing and allowing html5 specific tags like section, and etc. Sigil-0.9.8 also supports javascript based local-storage and display of embedded pdfs.

Download Location
The official location for downloading this Sigil release (and all official releases) is:

https://github.com/Sigil-Ebook/Sigil/releases/tag/0.9.8 (downloads found at the bottom)

The latest version of the Sigil User Guide can be downloaded from: https://github.com/Sigil-Ebook/Sigil/raw/master/docs/Sigil_User_Guide_0_7_2.epub

Downloading binaries from anyplace else is simply NOT a good idea as they could inject anything into their own downloads. After downloading, please verify the downloaded binary exactly matches what was originally posted by running an SHA 256 checksum on the file before installing it. See the file Sigil-0.9.8-CHECKSUMS.sha256.txt for the correct checksums for each file and instructions for how to calculate a SHA 256 Checksum for your download. The Mac OS X Package has also been code signed with my Apple Developer signature.

Windows Users
If your current version of Sigil is 0.9.6 or earlier, it's recommended (but not required) that you uninstall that version before installing 0.9.8. Some compiled Python files have had their file extentions changed (as well as the change to Python 3.5). As a result, there will be a lot of extraneous files left lying around if you just install the new over the old. It won't cause any functionality problems, but if disk space is at a premium, you may want to clean things up a bit. You can do this by uninstalling Sigil at any time (even after 0.9.8 is installed) and reinstalling. Doing so won't affect your any of your preferences, plugins, keyboard shortcuts, clips, saved searches, etc.

Linux Users
There are currently no official binary releases available for Linux on the Sigil Release page. Please check with your favorite distro's software repositories to see if they have Sigil for installation via your OS's package management system. If not, there are build instructions for compiling Sigil yourself in the source archive's docs directory: https://github.com/Sigil-Ebook/Sigil/tree/master/docs

Don't forget the FlightCrew plugin
Please note, the epub2 validator FlightCrew has been converted to a plugin for Sigil 0.8.900 and later.
This plugin has been updated for Sigil-0.9.3 (and later). It can be downloaded from the official Sigil-Ebook flightcrew repository if you have not already installed it.

https://github.com/Sigil-Ebook/flightcrew/releases/tag/0.9.1

Attention Mac OS X Users
Per the recommendation of www.python.org (see https://www.python.org/download/mac/tcltk/), due to bugs and the age of Apple's internal Tcl library, you should also download and install ActiveState's ActiveTcl Community Edition. To get the latest bug fixes, Sigil-0.9.8's embedded Python has been linked with the very latest version: Tcl 8.6.4.1

We may not redistribute this Package with Sigil due to ActiveState's binary non-redistribution policy.

So please, if you have not already done so download and install this version of ActiveState's Active Tcl Community Edition, until we get a chance to do our own build of Tcl 8.6.4.1 from source for future releases. ActiveState is a primary contributor to www.python.org and a respected and trusted source for python and tcl/tk related binaries on both Windows and Mac OS X.

See: http://www.activestate.com/activetcl/downloads
Version: 8.6.4.1

Some Additional things

When you fire up Sigil for the very first time:

• navigate to the new General Preferences and select the default
  epub version you plan to work with (epub 2 or epub3) so that new
  empty ebooks start with the correct code.
• if you plan to work with epub3 epubs, you should change your
  PreserveEntities setting to use ONLY NUMERIC entities.
  For example use & # 1 6 0 ; for non-breaking spaces and etc.
• We strongly recommend enabling Mend On Open in your settings
  for best performance with Sigil

Update April 10th
The Sigil 0.9.8 Mac Package has yet again been updated to hopefully now
work as intended (and for as far back as OSX 10.9)

** Please note the Checksums file has been updated to reflect the new checksums

Sigil-0.9.7

This is a buggy version of Sigil. Don't use it!

This Sigil-0.9.7 release is a mix of bug fixes and new features for both epub2 and epub3 users.

Bug Fixes

• Allow tags in the svg and mathml namespace to automtically self-close if empty to help work around a bug in Kindlegen that will not seem to accept a closing svg image tag even though image is non-void
• Prevent TextTab from constantly recentering page when focus is lost
• Fix bugs in plugin basename_to_id when used with xpgt files or any unrecognized extensions
• Fix typos in pls mimetype in plugins
• Fix code synchronization issues among 3 places where file extensions are mapped to mimetypes
• Fix plugin readotherfile interface to rebuild the opf on the fly only if it has been modified
• Fix plugin validation issues with integer vs string representations of line number and character offsets
• Fix duplicate filename in multiple directories bug when updating CSS urls
• Fix bug in page-map.xml mimetype when "Add Existing ..." is used
• Fix undefined behaviour shifting signed negative values in 3rdparty libs and fix many warnings
• Fix text vs binary file type recognition in the plugin interface (CSS and js files are text not binary)
• Fix too small toolbar icons on high dpi displays
• Fix bug that caused text highlighting to get lost on some systems when doing a CSS Find & Replace.
• Fix bug in plugin interface basename_to_id to recognize .htm extensions
• Fix bug in epub3 semantic popups to always refect the local name of epub:type setting
• Fix bug where creation on an HTML TOC could overwrite an existing Nav under epub3
• Fix manifest id not starting with alpha character bug

New Features

• Extend validation plugin interface with add_extended_result() method to allow better cursor positioning
• Extend TextTab and Tabs derived by it to position cursor based on offset
• Allow editing of page-map.xml files, xpgt files and other misc xml based files inside Sigil
• Update Windows builds use Python 3.5.2, VS2015
• Update Mac OS X builds and build instructions to use Python-3.5.2
• Remove support for python2.7 only plugins and simply Manage Plugins settings
• Update to Qt 5.6.1-1 with QtWebKit added back for release builds for Windows (VS2015) and Mac OSX
• Update Mac OS X and Linux build instruction documentation for recent changes
• Allow Linux Dictionaries to look up default paths for dictionaries passed in by build cmake settings
• Make the columns in the Manage Plugins table be sortable by the user
• Better detect undefined and non-existing url fragments to prevent issues when splitting or merging files
• Make tooltips for Run Plugin Icons show the name of the selected plugin on hover
• Upgrade from jquery 1.6.2 to version 2.2.4
• Upgrade from jquery.scrollTo 1.4.2 to version 2.1.2
• Upgrade to double sized 48x48 pixel icons for High DPI displays, Special Thanks to PatNY for creating our icons

Be aware that Sigil-0.9.7 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

Sigil-0.9.7 like its predecessors passed all of the following tests for epub3 support: iframe, img, audio, video , mathml, svg (except for svg support in the spine), javascript, and of course recognizing and allowing html5 specific tags like section, and etc. Sigil-0.9.7 also supports javascript based local-storage and display of embedded pdfs.

Download Location
The official location for downloading this Sigil release (and all official releases) is:

https://github.com/Sigil-Ebook/Sigil/releases/tag/0.9.7

Downloading binaries from anyplace else is simply NOT a good idea as they could inject anything into their own downloads. After downloading, please verify the downloaded binary exactly matches what was originally posted by running an SHA 256 checksum on the file before installing it. See the file Sigil-0.9.7-CHECKSUMS.sha256.txt for the correct checksums for each file and instructions for how to calculate a SHA 256 Checksum for your download. The Mac OS X Package has also been code signed with my Apple Developer signature.

Windows Users
If your current version of Sigil is 0.9.6 or earlier, it's recommended (but not required) that you uninstall that version before installing 0.9.7. Some compiled Python files have had their file extentions changed (as well as the change to Python 3.5). As a result, there will be a lot of extraneous files left lying around if you just install the new over the old. It won't cause any functionality problems, but if disk space is at a premium, you may want to clean things up a bit. You can do this by uninstalling Sigil at any time (even after 0.9.7 is installed) and reinstalling. Doing so won't affect your any of your preferences, plugins, keyboard shortcuts, clips, saved searches, etc.

Linux Users
There are currently no binary releases available for Linux on the Sigil Release page. Please check with your favorite distro's software repositories to see if they have Sigil for installation via your OS's package management system. If not, there are build instructions for compiling Sigil yourself in the source archive's docs directory: https://github.com/Sigil-Ebook/Sigil/tree/master/docs

Don't forget the FlightCrew plugin
Please note, the epub2 validator FlightCrew has been converted to a plugin for Sigil 0.8.900 and later.
This plugin has been updated for Sigil-0.9.3 (and later). It can be downloaded from the official Sigil-Ebook flightcrew repository if you have not already installed it.

https://github.com/Sigil-Ebook/flightcrew/releases/tag/0.9.1

Attention Mac OS X Users
Per the recommendation of www.python.org (see https://www.python.org/download/mac/tcltk/), due to bugs and the age of Apple's internal Tcl library, you should also download and install ActiveState's ActiveTcl Community Edition. To get the latest bug fixes, Sigil-0.9.7's embedded Python has been linked with the very latest version: Tcl 8.6.4.1

We may not redistribute this Package with Sigil due to ActiveState's binary non-redistribution policy.

So please, if you have not already done so download and install this version of ActiveState's Active Tcl Community Edition, until we get a chance to do our own build of Tcl 8.6.4.1 from source for future releases. ActiveState is a primary contributor to www.python.org and a respected and trusted source for python and tcl/tk related binaries on both Windows and Mac OS X.

See: http://www.activestate.com/activetcl/downloads
Version: 8.6.4.1

Some Additional things

When you fire up Sigil for the very first time:

• navigate to the new General Preferences and select the default
  epub version you plan to work with (epub 2 or epub3) so that new
  empty ebooks start with the correct code.
• if you plan to work with epub3 epubs, you should change your
  PreserveEntities setting to use ONLY NUMERIC entities.
  For example use & # 1 6 0 ; for non-breaking spaces and etc.
• We strongly recommend enabling Mend On Open in your settings
  for best performance with Sigil

Sigil-0.9.6

This Sigil-0.9.6 release is a mix of bug fixes and new features for both epub2 and epub3 users.

Bug Fixes
- Make StdWarningDialog resizeable when "Show Details" is used
- Fix CleanSource svg prefix removal bug that sometimes broke valid svg code
- Remove svg image and html5 menuitem from the list of void elements in the Sigil and plugin code
- Properly xml escape "&" in metadata attribute values
- Properly perform source updates on epub on load even when they do not follow recommended spec
- Make handling of comments in both xhtml and xml more robust
- Properly url escape css file names to handle css files with spaces in them
- Try to make direct editing of content.opf more safe by auto-fixing errors when possible
- Properly handle WellFormed checks for pure XML in XMLResource.cpp by using embedded python3 lxml
- Make opf_newparser.py and xmlprocessor.py more robust to broken user input in content.opf
- Make ProcessXML (repairXML in xmlprocessor.py) - leave untouched anything well-formed
- Fix thinko in plugin bookcontainer.py and outputcontainer.py contributed by wrCisco
- Fix for improper encoding in plugins on Mac OS X due to missing inherited plugin environment
- Fix for typos in epub xmlns when splitting epub3 ebooks in BookView
- Update testplugin_v012.zip to testplugin_v013.zip to handle sgc-nav.css new feature
- Fix bugs in DeleteUnusedStyles when selector exists more than once in the same stylesheet
- Fix bugs in DeleteUnusedStyles when group selectors span more than one line
- Fix bugs in Reports: CSS Styles missing cases when selector exists more than once
- Fix bug in Reports: All Files to use Landmark Semantics under epub3 not guide semantics
- Fix bug, slow in loading ini when too large clipboard history, user can now delete them via dialog
- Stop cosmetic double-spaces being introduced into OPF manifest, spine and guide entries
- Prevent bug when user selects too much in BookView and then tries to change case
- Fix bug in Delete Unused Media when css urls do not use quotes
- Try to set all ways of updating the ncx to use 2 character indentation of head element
- Fix Building Relocatable Python on Mac build instructions to remove BeautifulSoup4 requirement
- Fix for generating empty guide for epub3 when in plugins

New Features
- created sgc-nav.css stylesheet for nav and allow templates in Prefs Dir for user to control it
- Added General Setting to allow user to set own temporary directory location
- Added Qt Stylesheet support - Recognize and load "qt_styles.qss" file if stored in Sigil Preferences folder
- Extended the plugin interface to add support for epub3 bindings elements
- Add option + forward delete shortcut to active Metadata Editor remove

Be aware that Sigil-0.9.6 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

Sigil-0.9.6 like its predecessors passed all of the following tests for epub3 support: iframe, img, audio, video , mathml, svg (except for svg support in the spine), javascript, and of course recognizing and allowing html5 specific tags like section, and etc. Sigil-0.9.6 also supports javascript based local-storage and display of embedded pdfs.

Download Location
The official location for downloading this Sigil release (and all official releases) is:

https://github.com/Sigil-Ebook/Sigil/releases/tag/0.9.6

Downloading binaries from anyplace else is simply NOT a good idea as they could inject anything into their own downloads. After downloading, please verify the downloaded binary exactly matches what was originally posted by running an SHA 256 checksum on the file before installing it. See the file Sigil-0.9.6-CHECKSUMS.sha256.txt for the correct checksums for each file and instructions for how to calculate a SHA 256 Checksum for your download. The Mac OS X Package has also been code signed with my Apple Developer signature.

Linux Users
There are currently no binary releases available for Linux on the Sigil Release page. Please check with your favorite distro's software repositories to see if they have Sigil for installation via your OS's package management system. If not, there are build instructions for compiling Sigil yourself in the source archive's docs directory: https://github.com/Sigil-Ebook/Sigil/tree/master/docs

Don't forget the FlightCrew plugin
Please note, the epub2 validator FlightCrew has been converted to a plugin for Sigil 0.8.900 and later.
This plugin has been updated for Sigil-0.9.3 (and later). It can be downloaded from the official Sigil-Ebook flightcrew repository if you have not already installed it.

https://github.com/Sigil-Ebook/flightcrew/releases/tag/0.9.1

Attention Mac OS X Users
Per the recommendation of www.python.org (see https://www.python.org/download/mac/tcltk/), due to bugs and the age of Apple's internal Tcl library, you should also download and install ActiveState's ActiveTcl Community Edition. To get the latest bug fixes, Sigil-0.9.6's embedded Python has been linked with the very latest version: Tcl 8.6.4.1

We may not redistribute this Package with Sigil due to ActiveState's binary non-redistribution policy.

So please, if you have not already done so download and install this version of ActiveState's Active Tcl Community Edition, until we get a chance to do our own build of Tcl 8.6.4.1 from source for future releases. ActiveState is a primary contributor to www.python.org and a respected and trusted source for python and tcl/tk related binaries on both Windows and Mac OS X.

See:  http://www.activestate.com/activetcl/downloads
Version: 8.6.4.1 

Some Additional things

When you fire up Sigil for the very first time:

• navigate to the new General Preferences and select the default
  epub version you plan to work with (epub 2 or epub3) so that new
  empty ebooks start with the correct code.
• if you plan to work with epub3 epubs, you should change your
  PreserveEntities setting to use ONLY NUMERIC entities.
  For example use & # 1 6 0 ; for non-breaking spaces and etc.
• We strongly recommend enabling Mend On Open in your settings
  for best performance with Sigil

Sigil-0.9.5

This Sigil-0.9.5 release is a quick follow-up bug fix release to primarily address some regressions that had snuck into the code over the past two releases.

Bug Fixes

* Fix regression when ImportHTML in gathering HTML based DC. metadata
* Fix regression - remove incorrect use of opf:scheme from dc:creator and dc:contributor under epub2
* Fix regression - the guide reference tag is always a void tag
* Fix issues with hunspell spell checking under Windows when non-ascii paths to dictionaries
* Fix issues with overridding the prefs directory on Windows with non-ascii paths
* Fix broken manual "Check" button on W3C stylesheet validation's generated html form.
* Fix media-type recognition for .m4a and .m4v file extenstions in main Sigil and plugin code
* Treat ruby and rt as inline tags when pretty-printing in Sigils and for plugins

Even our one new feature fixes a bug in which CSS version is sued to validate CSS under epub3.

New Feature

* Allow user to choose what level of CSS gets used in the "Validate Stylesheets
     With W3C" tool via user preference (General).

Be aware that Sigil-0.9.5 still enforces the need for epub3 to have and support an NCX so that it generates as backward a compatible epub as possible. This may be relaxed in future releases.

Sigil-0.9.5 like its predecessors passed all of the following tests for epub3 support: iframe, img, audio, video , mathml, svg (except for svg support in the spine), javascript, and of course recognizing and allowing html5 specific tags like section, and etc. Sigil-0.9.5 also supports javascript based local-storage and display of embedded pdfs.

Download Location
The official location for downloading this Sigil release (and all official releases) is:

https://github.com/Sigil-Ebook/Sigil/releases/tag/0.9.5

Downloading binaries from anyplace else is simply not a good idea as they could inject anything into their own downloads. After downloading, please verify the downloaded binary exactly matches what was originally posted by running an SHA 256 checksum on the file before installing it. See the file Sigil-0.9.5-CHECKSUMS.sha256.txt for the correct checksums for each file and instructions for how to calculate a SHA 256 Checksum for your download. The Mac OS X Package has also been code signed with my Apple Developer signature.

Linux Users
There are currently no binary releases available for Linux on the Sigil Release page. Please check with your favorite distro's software repositories to see if they have Sigil for installation via your OS's package management system. If not, there are build instructions for compiling Sigil yourself in the source archive's docs directory: https://github.com/Sigil-Ebook/Sigil/tree/master/docs

Don't forget the FlightCrew plugin
Please note, the epub2 validator FlightCrew has been converted to a plugin for Sigil 0.8.900 and later.
This plugin has been updated for Sigil-0.9.3 (and later). It can be downloaded from the official Sigil-Ebook flightcrew repository if you have not already installed it.

https://github.com/Sigil-Ebook/flightcrew/releases/tag/0.9.1

Attention Mac OS X Users
Per the recommendation of www.python.org (see https://www.python.org/download/mac/tcltk/), due to bugs and the age of Apple's internal Tcl library, you should also download and install ActiveState's ActiveTcl Community Edition. To get the latest bug fixes, Sigil-0.9.5's embedded Python has been linked with the very latest version: Tcl 8.6.4.1

We may not redistribute this Package with Sigil due to ActiveState's binary non-redistribution policy.

So please, if you have not already done so download and install this version of ActiveState's Active Tcl Community Edition, until we get a chance to do our own build of Tcl 8.6.4.1 from source for future releases. ActiveState is a primary contributor to www.python.org and a respected and trusted source for python and tcl/tk related binaries on both Windows and Mac OS X.

See:  http://www.activestate.com/activetcl/downloads
Version: 8.6.4.1 

Some Additional things

When you fire up Sigil for the very first time:

• navigate to the new General Preferences and select the default
  epub version you plan to work with (epub 2 or epub3) so that new
  empty ebooks start with the correct code.
• if you plan to work with epub3 epubs, you should change your
  PreserveEntities setting to use ONLY NUMERIC entities.
  For example use & # 1 6 0 ; for non-breaking spaces and etc.
• We strongly recommend enabling Mend On Open in your settings
  for best performance with Sigil