novelWriter 2.4b1__tar.gz → 2.4rc1__tar.gz

{novelWriter-2.4b1 → novelWriter-2.4rc1}/CHANGELOG.md

@@ -1,5 +1,45 @@
 # novelWriter Changelog
 
+## Version 2.4 RC 1 [2024-04-06]
+
+### Release Notes
+
+This is a release candidate of the next release version, and is intended for testing purposes.
+Please be careful when using this version on writing projects, and make frequent backups.
+
+### Detailed Changelog
+
+**Bugfixes**
+
+* A number of issues GUI icon scaling has been fixed. Icons and buttons are supposed to scale
+  relative to the GUI font size, but several of them were not. Issue #1787. PR #1788.
+* The persistence of button state for the editor search box has been improved. The present state
+  was only saved when the search box was actively closed, and there were several scenarios where
+  this didn't happen. The button states are now tracked in the central config, and will always be
+  preserved. Issue #1794. PR #1795.
+
+**Other Improvements**
+
+* A placeholder icon has been added for cases where users have their own icon theme, and icons are
+  missing. Issue #1780. PR #1781.
+* The project search now refreshes the search results for the currently open document when it's
+  being edited. PR #1782.
+* When activating project search from the editor while text is selected, the search box is
+  populated with this text. Issue #1789. PR #1790.
+
+**Packaging**
+
+* The project has moved from using a `setup.cfg` to only using the `pyproject.toml` meta data file
+  for packaging. This is the preferred file format now. PR #1791.
+
+**Code Improvements**
+
+* The part of the code related to Qt widgets and flags has been updated and refactored in
+  preparation for the eventual move to the Qt6 framework. Part of issue #1142. PR #1792.
+* The Open Document writer class has been refactored and improved. PR #1796.
+
+----
+
 ## Version 2.4 Beta 1 [2024-03-26]
 
 ### Release Notes
@@ -7,9 +47,6 @@
 This is a beta release of the next release version, and is intended for testing purposes. Please be
 careful when using this version on live writing projects, and make sure you take frequent backups.
 
-Please check the changelog for an overview of changes. The full release notes will be added to the
-final release.
-
 ### Detailed Changelog
 
 **Major Features**

{novelWriter-2.4b1 → novelWriter-2.4rc1}/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.1
 Name: novelWriter
-Version: 2.4b1
+Version: 2.4rc1
 Summary: A markdown-like text editor for planning and writing novels
-Home-page: https://novelwriter.io
-Author: Veronica Berglyd Olsen
-Author-email: code@vkbo.net
+Author-email: Veronica Berglyd Olsen <code@vkbo.net>
 License: GNU General Public License v3
-Project-URL: Bug Tracker, https://github.com/vkbo/novelWriter/issues
+Project-URL: Homepage, https://novelwriter.io
 Project-URL: Documentation, https://docs.novelwriter.io
-Project-URL: Source Code, https://github.com/vkbo/novelWriter
+Project-URL: Repository, https://github.com/vkbo/novelWriter
+Project-URL: Issues, https://github.com/vkbo/novelWriter/issues
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelWriter.egg-info/PKG-INFO

@@ -1,14 +1,13 @@
 Metadata-Version: 2.1
 Name: novelWriter
-Version: 2.4b1
+Version: 2.4rc1
 Summary: A markdown-like text editor for planning and writing novels
-Home-page: https://novelwriter.io
-Author: Veronica Berglyd Olsen
-Author-email: code@vkbo.net
+Author-email: Veronica Berglyd Olsen <code@vkbo.net>
 License: GNU General Public License v3
-Project-URL: Bug Tracker, https://github.com/vkbo/novelWriter/issues
+Project-URL: Homepage, https://novelwriter.io
 Project-URL: Documentation, https://docs.novelwriter.io
-Project-URL: Source Code, https://github.com/vkbo/novelWriter
+Project-URL: Repository, https://github.com/vkbo/novelWriter
+Project-URL: Issues, https://github.com/vkbo/novelWriter/issues
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelWriter.egg-info/SOURCES.txt

@@ -5,12 +5,10 @@ MANIFEST.in
 README.md
 pkgutils.py
 pyproject.toml
-setup.cfg
 novelWriter.egg-info/PKG-INFO
 novelWriter.egg-info/SOURCES.txt
 novelWriter.egg-info/dependency_links.txt
 novelWriter.egg-info/entry_points.txt
-novelWriter.egg-info/not-zip-safe
 novelWriter.egg-info/requires.txt
 novelWriter.egg-info/top_level.txt
 novelwriter/__init__.py
@@ -21,6 +19,7 @@ novelwriter/enum.py
 novelwriter/error.py
 novelwriter/guimain.py
 novelwriter/shared.py
+novelwriter/types.py
 novelwriter/assets/manual.pdf
 novelwriter/assets/sample.zip
 novelwriter/assets/i18n/nw_de_DE.qm
@@ -46,6 +45,7 @@ novelwriter/assets/i18n/project_nn_NO.json
 novelwriter/assets/i18n/project_pt_BR.json
 novelwriter/assets/i18n/project_ru_RU.json
 novelwriter/assets/i18n/project_zh_CN.json
+novelwriter/assets/icons/none.svg
 novelwriter/assets/icons/novelwriter.ico
 novelwriter/assets/icons/novelwriter.svg
 novelwriter/assets/icons/x-novelwriter-project.ico
@@ -90,12 +90,10 @@ novelwriter/assets/icons/typicons_dark/nw_tb-subscript.svg
 novelwriter/assets/icons/typicons_dark/nw_tb-superscript.svg
 novelwriter/assets/icons/typicons_dark/nw_tb-underline.svg
 novelwriter/assets/icons/typicons_dark/typ_arrow-down-thick-grey.svg
-novelwriter/assets/icons/typicons_dark/typ_arrow-down.svg
 novelwriter/assets/icons/typicons_dark/typ_arrow-forward.svg
 novelwriter/assets/icons/typicons_dark/typ_arrow-maximise.svg
 novelwriter/assets/icons/typicons_dark/typ_arrow-minimise.svg
 novelwriter/assets/icons/typicons_dark/typ_arrow-repeat-grey.svg
-novelwriter/assets/icons/typicons_dark/typ_arrow-right.svg
 novelwriter/assets/icons/typicons_dark/typ_book-grey.svg
 novelwriter/assets/icons/typicons_dark/typ_book.svg
 novelwriter/assets/icons/typicons_dark/typ_bookmark.svg
@@ -146,6 +144,8 @@ novelwriter/assets/icons/typicons_dark/typ_th-list-grey.svg
 novelwriter/assets/icons/typicons_dark/typ_th-list.svg
 novelwriter/assets/icons/typicons_dark/typ_times.svg
 novelwriter/assets/icons/typicons_dark/typ_trash.svg
+novelwriter/assets/icons/typicons_dark/typ_unfold-hidden.svg
+novelwriter/assets/icons/typicons_dark/typ_unfold-visible.svg
 novelwriter/assets/icons/typicons_dark/typ_user.svg
 novelwriter/assets/icons/typicons_dark/typ_warning-full.svg
 novelwriter/assets/icons/typicons_light/README.md
@@ -188,12 +188,10 @@ novelwriter/assets/icons/typicons_light/nw_tb-subscript.svg
 novelwriter/assets/icons/typicons_light/nw_tb-superscript.svg
 novelwriter/assets/icons/typicons_light/nw_tb-underline.svg
 novelwriter/assets/icons/typicons_light/typ_arrow-down-thick-grey.svg
-novelwriter/assets/icons/typicons_light/typ_arrow-down.svg
 novelwriter/assets/icons/typicons_light/typ_arrow-forward.svg
 novelwriter/assets/icons/typicons_light/typ_arrow-maximise.svg
 novelwriter/assets/icons/typicons_light/typ_arrow-minimise.svg
 novelwriter/assets/icons/typicons_light/typ_arrow-repeat-grey.svg
-novelwriter/assets/icons/typicons_light/typ_arrow-right.svg
 novelwriter/assets/icons/typicons_light/typ_book-grey.svg
 novelwriter/assets/icons/typicons_light/typ_book.svg
 novelwriter/assets/icons/typicons_light/typ_bookmark.svg
@@ -244,6 +242,8 @@ novelwriter/assets/icons/typicons_light/typ_th-list-grey.svg
 novelwriter/assets/icons/typicons_light/typ_th-list.svg
 novelwriter/assets/icons/typicons_light/typ_times.svg
 novelwriter/assets/icons/typicons_light/typ_trash.svg
+novelwriter/assets/icons/typicons_light/typ_unfold-hidden.svg
+novelwriter/assets/icons/typicons_light/typ_unfold-visible.svg
 novelwriter/assets/icons/typicons_light/typ_user.svg
 novelwriter/assets/icons/typicons_light/typ_warning-full.svg
 novelwriter/assets/images/novelwriter-text-dark.svg
@@ -273,7 +273,6 @@ novelwriter/assets/themes/default_dark.conf
 novelwriter/assets/themes/default_light.conf
 novelwriter/assets/themes/solarized_dark.conf
 novelwriter/assets/themes/solarized_light.conf
-novelwriter/core/__init__.py
 novelwriter/core/buildsettings.py
 novelwriter/core/coretools.py
 novelwriter/core/docbuild.py
@@ -293,7 +292,6 @@ novelwriter/core/tokenizer.py
 novelwriter/core/tomd.py
 novelwriter/core/toodt.py
 novelwriter/core/tree.py
-novelwriter/dialogs/__init__.py
 novelwriter/dialogs/about.py
 novelwriter/dialogs/docmerge.py
 novelwriter/dialogs/docsplit.py
@@ -302,7 +300,6 @@ novelwriter/dialogs/preferences.py
 novelwriter/dialogs/projectsettings.py
 novelwriter/dialogs/quotes.py
 novelwriter/dialogs/wordlist.py
-novelwriter/extensions/__init__.py
 novelwriter/extensions/circularprogress.py
 novelwriter/extensions/configlayout.py
 novelwriter/extensions/eventfilters.py
@@ -314,7 +311,6 @@ novelwriter/extensions/statusled.py
 novelwriter/extensions/switch.py
 novelwriter/extensions/switchbox.py
 novelwriter/extensions/versioninfo.py
-novelwriter/gui/__init__.py
 novelwriter/gui/doceditor.py
 novelwriter/gui/dochighlight.py
 novelwriter/gui/docviewer.py
@@ -329,9 +325,7 @@ novelwriter/gui/search.py
 novelwriter/gui/sidebar.py
 novelwriter/gui/statusbar.py
 novelwriter/gui/theme.py
-novelwriter/text/__init__.py
 novelwriter/text/counting.py
-novelwriter/tools/__init__.py
 novelwriter/tools/dictionaries.py
 novelwriter/tools/lipsum.py
 novelwriter/tools/manusbuild.py

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelwriter/__init__.py

@@ -42,9 +42,9 @@ __license__    = "GPLv3"
 __author__     = "Veronica Berglyd Olsen"
 __maintainer__ = "Veronica Berglyd Olsen"
 __email__      = "code@vkbo.net"
-__version__    = "2.4b1"
-__hexversion__ = "0x020400b1"
-__date__       = "2024-03-26"
+__version__    = "2.4rc1"
+__hexversion__ = "0x020400c1"
+__date__       = "2024-04-06"
 __status__     = "Stable"
 __domain__     = "novelwriter.io"
 
@@ -187,7 +187,7 @@ def main(sysArgs: list | None = None):
         ))
         for errLine in errorData:
             logger.critical(errLine)
-        errApp.exec_()
+        errApp.exec()
         sys.exit(errorCode)
 
     # Finish initialising config
@@ -237,6 +237,6 @@ def main(sysArgs: list | None = None):
         nwGUI = GuiMain()
         nwGUI.postLaunchTasks(cmdOpen)
 
-        sys.exit(nwApp.exec_())
+        sys.exit(nwApp.exec())
 
 # END Function main

novelWriter-2.4rc1/novelwriter/assets/icons/none.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24" height="24" version="1.2" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+ <path d="m0 0v4l8 8-8 8v4h4l8-8 8 8h4v-4l-8-8 8-8v-4h-4l-8 8-8-8h-4z" fill="#f00" stroke-width=".70711"/>
+</svg>

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelwriter/assets/icons/typicons_dark/icons.conf

@@ -100,8 +100,8 @@ status_time     = typ_stopwatch-grey.svg
 sticky-off      = typ_pin-outline.svg
 sticky-on       = typ_pin.svg
 unchecked       = mixed_input-unchecked.svg
-unfold-hide     = typ_arrow-right.svg
-unfold-show     = typ_arrow-down.svg
+unfold-hide     = typ_unfold-hidden.svg
+unfold-show     = typ_unfold-visible.svg
 up              = typ_chevron-up.svg
 view            = typ_eye.svg
 view_build      = typ_export-grey.svg

novelWriter-2.4rc1/novelwriter/assets/icons/typicons_dark/typ_unfold-hidden.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24" height="24" version="1.2" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+ <path d="m9.8767 17.723 5.8157-5.723-5.8157-5.723c-0.18462-0.18462-0.46155-0.27693-0.64616-0.27693-0.18462 0-0.46155 0.092309-0.64616 0.27693-0.18462 0.18462-0.27693 0.36924-0.27693 0.64616v10.154c0 0.27693 0.092309 0.46154 0.27693 0.64616 0.18462 0.18462 0.46155 0.27693 0.64616 0.27693 0.18462 0 0.46155-0.09231 0.64616-0.27693z" fill="#aeaeae" stroke-width=".92309"/>
+</svg>

novelWriter-2.4rc1/novelwriter/assets/icons/typicons_dark/typ_unfold-visible.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24" height="24" version="1.2" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+ <path d="m6.277 9.8767 5.723 5.8157 5.723-5.8157c0.18462-0.18462 0.27693-0.46155 0.27693-0.64616 0-0.18462-0.092309-0.46155-0.27693-0.64616-0.18462-0.18462-0.36924-0.27693-0.64616-0.27693h-10.154c-0.27693 0-0.46155 0.092309-0.64616 0.27693-0.18462 0.18462-0.27693 0.46155-0.27693 0.64616 0 0.18462 0.092309 0.46155 0.27693 0.64616z" fill="#aeaeae" stroke-width=".92309"/>
+</svg>

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelwriter/assets/icons/typicons_light/icons.conf

@@ -100,8 +100,8 @@ status_time     = typ_stopwatch-grey.svg
 sticky-off      = typ_pin-outline.svg
 sticky-on       = typ_pin.svg
 unchecked       = mixed_input-unchecked.svg
-unfold-hide     = typ_arrow-right.svg
-unfold-show     = typ_arrow-down.svg
+unfold-hide     = typ_unfold-hidden.svg
+unfold-show     = typ_unfold-visible.svg
 up              = typ_chevron-up.svg
 view            = typ_eye.svg
 view_build      = typ_export-grey.svg

novelWriter-2.4rc1/novelwriter/assets/icons/typicons_light/typ_unfold-hidden.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24" height="24" version="1.2" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+ <path d="m9.8767 17.723 5.8157-5.723-5.8157-5.723c-0.18462-0.18462-0.46155-0.27693-0.64616-0.27693-0.18462 0-0.46155 0.092309-0.64616 0.27693-0.18462 0.18462-0.27693 0.36924-0.27693 0.64616v10.154c0 0.27693 0.092309 0.46154 0.27693 0.64616 0.18462 0.18462 0.46155 0.27693 0.64616 0.27693 0.18462 0 0.46155-0.09231 0.64616-0.27693z" fill-opacity=".78039" stroke-width="1.6923"/>
+</svg>

novelWriter-2.4rc1/novelwriter/assets/icons/typicons_light/typ_unfold-visible.svg

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24" height="24" version="1.2" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+ <path d="m6.277 9.8767 5.723 5.8157 5.723-5.8157c0.18462-0.18462 0.27693-0.46155 0.27693-0.64616 0-0.18462-0.09231-0.46155-0.27693-0.64616-0.18462-0.18462-0.36924-0.27693-0.64616-0.27693h-10.154c-0.27693 0-0.46155 0.092309-0.64616 0.27693-0.18462 0.18462-0.27693 0.46155-0.27693 0.64616 0 0.18462 0.092309 0.46155 0.27693 0.64616z" fill-opacity=".78039" stroke-width="1.6923"/>
+</svg>

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelwriter/common.py

@@ -36,7 +36,7 @@ from configparser import ConfigParser
 from urllib.parse import urljoin
 from urllib.request import pathname2url
 
-from PyQt5.QtGui import QDesktopServices
+from PyQt5.QtGui import QColor, QDesktopServices
 from PyQt5.QtCore import QCoreApplication, QUrl
 
 from novelwriter.enum import nwItemClass, nwItemType, nwItemLayout
@@ -382,6 +382,11 @@ def numberToRoman(value: int, toLower: bool = False) -> str:
     return roman.lower() if toLower else roman
 
 
+def cssCol(col: QColor, alpha: int | None = None) -> str:
+    """Convert a QColor object to an rgba entry to use in CSS."""
+    return f"rgba({col.red()}, {col.green()}, {col.blue()}, {alpha or col.alpha()})"
+
+
 ##
 #  Encoder Functions
 ##

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelwriter/config.py

@@ -61,8 +61,12 @@ class Config:
         self.appHandle = "novelwriter"
 
         # Set Paths
-        confRoot = Path(QStandardPaths.writableLocation(QStandardPaths.ConfigLocation))
-        dataRoot = Path(QStandardPaths.writableLocation(QStandardPaths.AppDataLocation))
+        confRoot = Path(QStandardPaths.writableLocation(
+            QStandardPaths.StandardLocation.ConfigLocation)
+        )
+        dataRoot = Path(QStandardPaths.writableLocation(
+            QStandardPaths.StandardLocation.AppDataLocation)
+        )
 
         self._confPath = confRoot.absolute() / self.appHandle  # The user config location
         self._dataPath = dataRoot.absolute() / self.appHandle  # The user data location
@@ -83,7 +87,7 @@ class Config:
         # Localisation
         # Note that these paths must be strings
         self._nwLangPath = self._appPath / "assets" / "i18n"
-        self._qtLangPath = QLibraryInfo.location(QLibraryInfo.TranslationsPath)
+        self._qtLangPath = QLibraryInfo.location(QLibraryInfo.LibraryLocation.TranslationsPath)
 
         hasLocale = (self._nwLangPath / f"nw_{QLocale.system().name()}.qm").exists()
         self._qLocale = QLocale.system() if hasLocale else QLocale("en_GB")
@@ -369,7 +373,7 @@ class Config:
             elif self.osDarwin and "Helvetica" in fontFam:
                 self.textFont = "Helvetica"
             else:
-                self.textFont = fontDB.systemFont(QFontDatabase.GeneralFont).family()
+                self.textFont = fontDB.systemFont(QFontDatabase.SystemFont.GeneralFont).family()
         else:
             self.textFont = family
         return

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelwriter/core/coretools.py

@@ -337,32 +337,32 @@ class DocSearch:
         """Iteratively search through documents in a project."""
         self._regEx.setPattern(self._buildPattern(search))
         logger.debug("Searching with pattern '%s'", self._regEx.pattern())
-
-        num = len(search)
         storage = project.storage
         for item in project.tree:
             if item.isFileType():
-                text = storage.getDocumentText(item.itemHandle)
-                rxItt = self._regEx.globalMatch(text)
-                count = 0
-                capped = False
-                results = []
-                while rxItt.hasNext():
-                    rxMatch = rxItt.next()
-                    pos = rxMatch.capturedStart()
-                    num = rxMatch.capturedLength()
-                    context = text[pos:pos+100].partition("\n")[0]
-                    if context:
-                        results.append((pos, num, context))
-                        count += 1
-                        if count >= nwConst.MAX_SEARCH_RESULT:
-                            capped = True
-                            break
-
+                results, capped = self.searchText(storage.getDocumentText(item.itemHandle))
                 yield item, results, capped
-
         return
 
+    def searchText(self, text: str) -> tuple[list[tuple[int, int, str]], bool]:
+        """Search a piece of text for RegEx matches."""
+        rxItt = self._regEx.globalMatch(text)
+        count = 0
+        capped = False
+        results = []
+        while rxItt.hasNext():
+            rxMatch = rxItt.next()
+            pos = rxMatch.capturedStart()
+            num = rxMatch.capturedLength()
+            context = text[pos:pos+100].partition("\n")[0]
+            if context:
+                results.append((pos, num, context))
+                count += 1
+                if count >= nwConst.MAX_SEARCH_RESULT:
+                    capped = True
+                    break
+        return results, capped
+
     ##
     #  Internal Functions
     ##
@@ -382,8 +382,7 @@ class DocSearch:
                         escaped += f"\\{c}"
                 search = escaped
         if self._words:
-            search = search if search.startswith("\\b") else f"\\b{search}"
-            search = search if search.endswith("\\b") else f"{search}\\b"
+            search = f"(?:^|\\b){search}(?:$|\\b)"
         return search
 
 # END Class DocSearch

{novelWriter-2.4b1 → novelWriter-2.4rc1}/novelwriter/core/status.py

@@ -35,6 +35,7 @@ from PyQt5.QtCore import QRectF
 
 from novelwriter import CONFIG
 from novelwriter.common import minmax, simplified
+from novelwriter.types import QtPaintAnitAlias, QtTransparent
 
 if TYPE_CHECKING:  # pragma: no cover
     from typing import TypeGuard  # Requires Python 3.10
@@ -248,10 +249,10 @@ class NWStatus:
     def _createIcon(self, red: int, green: int, blue: int) -> QIcon:
         """Generate an icon for a status label."""
         pixmap = QPixmap(self._iPX, self._iPX)
-        pixmap.fill(QColor(0, 0, 0, 0))
+        pixmap.fill(QtTransparent)
 
         painter = QPainter(pixmap)
-        painter.setRenderHint(QPainter.Antialiasing)
+        painter.setRenderHint(QtPaintAnitAlias)
         painter.fillPath(self._iconPath, QColor(red, green, blue))
         painter.end()