Sigil-1.0.0 Release

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

Sigil-1.0.0 Github Release page and downloads.

PageEdit-1.0.0 Release

PageEdit-1.0. is primarily a new features release to add the ability to create hyperlinks.

New Features

  • added ability to insert “id” attibutes into current xhtml file
  • added ability to insert hyperlinks to other existing xhtml files (only when opened with OPF)
  • added ability to insert links to existing images, audio, and video (open when opened with OPF)

Bug Fixes

  • modified Qt code to fix the return after an h6 heading bug
  • whitespace is now preserved in code tags

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

The latest official PageEdit user guide can always be downloaded from its own repository. There’s also a user-created guide that can be found here.

PageEdit-0.9.6 Release

PageEdit-0.9.6 is primarily a bug-fix release.

New Features

  • an installer for the Windows platform

Bug Fixes

  • properly handle javascript location.href style links
  • try to prevent crashes when files deleted out from under PageEdit
  • fix the longest common path routine to actually work
  • remove the load text filter as it was not supported
  • set default paragraph separator to ‘p’ not ‘div’ when editing

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

Sigil-0.9.18 Release

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

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.

PageEdit-0.9.5 Release

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

PageEdit-0.9.5 is is primarily a new features release.

One of the major new features of this release is the ability to pass all xhtml files in the spine in Reading Order to PageEdit via opening the OPF. Make sure to check out the New Features Synopsis and the New Features Video in the downloads section of the Github release page.

Here is a more complete list of the changes:

New Features

  • add the ability to pass all xhtml files in the spine in Reading Order to PageEdit
    via opening the OPF. Allow quick file navigation via navigation menu and next
    and previous arrows keys.

  • add a Edit vs Preview mode toggle icon that will allow links among xhtmls files in the spine
    to be active and work (in Mode: Preview)

  • installed a QtMessage handler to create a debug log file controlled via a
    PAGEEDIT_DEBUG_LOGFILE environment setting, to simplify user bug issue feedback

Bug Fixes

  • fix macOS specific launch bugs due to bug in canonical files and timing of Apple events
  • make sure jQuery is loaded before trying to manipulate a file by imporving web load sequence
  • use GetEnvironmentVar to uniformly access Environment Vars in a cross platform manner
  • disable prev and next navigation buttons when only one input xhtml file exists

PageEdit-0.8.0 Release

PageEdit-0.8.0

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

PageEdit-0.8.0 is is primarily a new features release.

The major new features include the addition of Find and Spellchecking. In addition, the user now can set Preferences to determine how they would like to handle how PageEdit handles sequences of whitespace by either injecting non-breaking spaces (the default) or setting styles to use white-space:pre-wap.

In addition by setting the environment variable “PAGEEDIT_ENABLE_WORD_PASTE_CLEANUP” to 1 will enable extra cleanup code during Save that will remove much of the cruft leftover when pasting formatted text from Microsoft Word into PageEdit. This feature is experimental and can remove both xhtml comments and remove any style tags used in the body (not head!).

Here is a more complete list of the changes:

New Features

  • add user preferences to control use of white-space:pre-wrap vs nbsp chars
  • add user preferences to set spellchecking dictionary
  • add SpellChecking capability for QWebEngine Dictionaries
    (.bdic modified version of Hunspell dictionaries)
  • add Find capability (no replace just as in BookView)
  • allow cleanup after paste from Word during Save using
    environment variable:PAGEEDIT_ENABLE_WORD_PASTE_CLEANUP
    Note: risky since it removes style tags that are in the body and all xhtml comments

Bug Fixes

  • remove spurious newlines in injected user stylesheets and controls (Thanks BeckyDTP!)
  • actually compare source to detect all changes
  • fix macOS specific bug that allowed multiple Dockwidget MainWindows to become tabs

Sigil-0.9.17 Release

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

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.