novelWriter 2.5.1__tar.gz → 2.6b1__tar.gz

{novelwriter-2.5.1 → novelwriter-2.6b1}/CHANGELOG.md

@@ -1,5 +1,107 @@
 # novelWriter Changelog
 
+## Version 2.6 Beta 1 [2024-11-12]
+
+### Release Notes
+
+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.
+
+### Detailed Changelog
+
+**New Features**
+
+* Added PDF build format. Issue #2046. PR #2048.
+* Added DocX (MS Word) format. Issue #1537. PR #2056.
+* The Build settings tool has the following changes: Ability to control page break and centring of
+  main titles, an option to disable styling for headings altogether, and the ODT section has been
+  generalised to apply to all document formats. Issue #2023. PR #2045.
+* Text and heading margin can now be control in the Manuscript Build tool. Issue #2023. PR #2051.
+* Word counts and other such statistics can now be inserted into the manuscript. This is done
+  through new insert actions in the Insert menu, and processed at build time. Issue #2024.
+  PR #2073.
+* Forced line breaks can now be inserted as a shortcode. This is useful when line breaks in
+  paragraphs are ignored when building the manuscript. Issue #1991. PR #2063.
+* A new `@mentions` keyword has been added that can list any tag in the project as being mentioned
+  in the current section. These are listed separately from tags present in the story section.
+  Issue #1822. PR #2064.
+* Tags in novel documents can now be referenced with the `@story` keyword. Issue #1990. PR #2072.
+* URLs starting with http/https are now recognised and clickable in the editor, viewer, and
+  manuscript preview. Issue #1426. PR #2067.
+* Added dialogue highlighting for Portuguese and Polish dialogue styles. Issues #2066 and #2070.
+  Related to #1773. PRs #2068, #2079, #2081 and #2082.
+* Four dashes in the editor are now replaced by a horizontal bar. This is useful as a replacement
+  symbol for em dash when using dialogue highlighting to avoid triggering it. The horizontal bar is
+  replaced with an em dash in the manuscript. Issue #2070. PR #2079.
+* Manuscript Build settings can now be duplicated. Issue #1931. PR #2084.
+* Page breaks can optionally be made visible in the Manuscript preview. PR #2086.
+* The document status label can now be selected in the Outline View. Issue #1909. PR #2088.
+* The document viewer now has an edit button to open the document in the editor. Issue #1963.
+  PR #2089.
+
+**User Interface**
+
+* The Manuscript Build settings have now been moved into a single scrollable page, using the same
+  layout as in Preferences. The heading and filtering pages are still separate forms, as they are
+  of a more complex nature. PR #2031.
+* The currently open document in the editor is now highlighted in the project tree, just like it is
+  in the novel view. Issue #1981. PR #2077.
+* The details panel in the Outline view is now resizable. PR #2078.
+
+**Improvements**
+
+* Add an option to ignore a word in the spell checker. An ignored word is ignored only for the
+  current writing session. PR #2030.
+* Word counts and other such statistics is now exported as custom variables to ODT files, and can
+  be inserted in the text in LibreOffice, and similar. Issue #2033. PR #2035.
+
+**Code Improvements**
+
+* Added Python 3.13 coverage to ensure the new Python release is supported. Issue #2040. PR #2044.
+* Preparation for Qt6: Clean up Qt enums. PR #2025.
+* Preparation for Qt6: Replace Qt regular expression tools with the internal Python re module for
+  markup processing and syntax highlighting. It is both slightly faster, and there are issues with
+  text encoding in at least some versions of Qt6 or PyQt6. PRs #2028 and #2043.
+* Preparation for Qt6: Added a wrapper function for connecting signals to slots that has a
+  different function signature. Python lambdas generate warnings inn Qt6. PR #2075.
+* Refactored manuscript formats and moved most of the processing to the Tokenizer class to simplify
+  the format classes and also make them more consistent. PRs #2060, #2061 and #2062.
+* The document builder has been refactored to support more generalised format classes. PR #2047.
+* Action parent assignment has been rafactored in the main menu. #2075.
+* Raw text format output has been refactored and reduced to just appending documents. PR #2087.
+
+----
+
+## Version 2.5.2 [2024-09-17]
+
+### Release Notes
+
+This is a patch release that fixes a series of issues mostly affecting dialogue highlighting in the
+document viewer. The way the text is formatted in the viewer changed a lot in 2.5, and there were a
+few issues with the new implementation. The tab stop distance setting was also ignored, but has now
+been fixed as well.
+
+### Detailed Changelog
+
+**Bugfixes**
+
+* Fixed an issue where the tab stop distance setting was being ignored in the document viewer. It
+  must be set again every time a document is loaded. Issue #1996. PR #2014.
+* Fixed an issue with overlapping formatting markers when processing text into new formats. This
+  issues was introduced when dialogue highlighting was added to the document viewer and manuscript
+  build. It arises because start and end of dialogue can occur on the same character as other
+  formatting, and then the order these markers are processed matters. This was not properly handled
+  in the code. Issue #2012. PR #2014.
+* Dialogue highlighting is now only applied to plain text paragraphs, not comments, headings, and
+  other places where there should be no dialogue. Issue #2013. PR #2014.
+* Note documents no longer get dialogue highlighting. Issue #2011. PR #2014.
+
+**Documentation**
+
+* Added a section about spell checking in the documentation. PR #2015.
+
+----
+
 ## Version 2.5.1 [2024-07-28]
 
 ### Release Notes

{novelwriter-2.5.1 → novelwriter-2.6b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: novelWriter
-Version: 2.5.1
+Version: 2.6b1
 Summary: A markdown-like text editor for planning and writing novels
 Author-email: Veronica Berglyd Olsen <code@vkbo.net>
 License: GNU General Public License v3
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Development Status :: 5 - Production/Stable

{novelwriter-2.5.1 → novelwriter-2.6b1}/README.md

@@ -29,6 +29,15 @@ documentation.
 * PyPi Project: [pypi.org/project/novelWriter](https://pypi.org/project/novelWriter)
 * Social Media: [fosstodon.org/@novelwriter](https://fosstodon.org/@novelwriter)
 
+## Sponsors
+
+<table style="border: none;">
+<tr>
+  <td><img align="left" style="height: 25px;" src="https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/signpath_logo.png"></td>
+  <td>Free code signing on Windows provided by <a href="https://about.signpath.io/">SignPath.io</a>, certificate by <a href="https://signpath.org/">SignPath Foundation</a>.</td>
+</tr>
+</table>
+
 ## Implementation
 
 novelWriter is written with Python 3 (3.9+) using Qt5 and PyQt5 (5.15 only), and is released on

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelWriter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: novelWriter
-Version: 2.5.1
+Version: 2.6b1
 Summary: A markdown-like text editor for planning and writing novels
 Author-email: Veronica Berglyd Olsen <code@vkbo.net>
 License: GNU General Public License v3
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Development Status :: 5 - Production/Stable

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelWriter.egg-info/SOURCES.txt

@@ -54,6 +54,7 @@ novelwriter/assets/icons/x-novelwriter-project.ico
 novelwriter/assets/icons/x-novelwriter-project.svg
 novelwriter/assets/icons/typicons_dark/README.md
 novelwriter/assets/icons/typicons_dark/icons.conf
+novelwriter/assets/icons/typicons_dark/mixed_copy.svg
 novelwriter/assets/icons/typicons_dark/mixed_document-chapter.svg
 novelwriter/assets/icons/typicons_dark/mixed_document-new.svg
 novelwriter/assets/icons/typicons_dark/mixed_document-note.svg
@@ -154,6 +155,7 @@ novelwriter/assets/icons/typicons_dark/typ_user.svg
 novelwriter/assets/icons/typicons_dark/typ_warning-full.svg
 novelwriter/assets/icons/typicons_light/README.md
 novelwriter/assets/icons/typicons_light/icons.conf
+novelwriter/assets/icons/typicons_light/mixed_copy.svg
 novelwriter/assets/icons/typicons_light/mixed_document-chapter.svg
 novelwriter/assets/icons/typicons_light/mixed_document-new.svg
 novelwriter/assets/icons/typicons_light/mixed_document-note.svg
@@ -296,11 +298,6 @@ novelwriter/core/sessions.py
 novelwriter/core/spellcheck.py
 novelwriter/core/status.py
 novelwriter/core/storage.py
-novelwriter/core/tohtml.py
-novelwriter/core/tokenizer.py
-novelwriter/core/tomarkdown.py
-novelwriter/core/toodt.py
-novelwriter/core/toqdoc.py
 novelwriter/core/tree.py
 novelwriter/dialogs/about.py
 novelwriter/dialogs/docmerge.py
@@ -320,6 +317,14 @@ novelwriter/extensions/statusled.py
 novelwriter/extensions/switch.py
 novelwriter/extensions/switchbox.py
 novelwriter/extensions/versioninfo.py
+novelwriter/formats/shared.py
+novelwriter/formats/todocx.py
+novelwriter/formats/tohtml.py
+novelwriter/formats/tokenizer.py
+novelwriter/formats/tomarkdown.py
+novelwriter/formats/toodt.py
+novelwriter/formats/toqdoc.py
+novelwriter/formats/toraw.py
 novelwriter/gui/doceditor.py
 novelwriter/gui/dochighlight.py
 novelwriter/gui/docviewer.py
@@ -355,6 +360,7 @@ setup/make_release.sh
 setup/novelwriter.appdata.xml
 setup/novelwriter_readme.png
 setup/novelwriter_text.png
+setup/signpath_logo.png
 setup/win_setup_embed.iss
 setup/data/novelwriter.desktop
 setup/data/novelwriter.png

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelwriter/__init__.py

@@ -47,9 +47,9 @@ __license__    = "GPLv3"
 __author__     = "Veronica Berglyd Olsen"
 __maintainer__ = "Veronica Berglyd Olsen"
 __email__      = "code@vkbo.net"
-__version__    = "2.5.1"
-__hexversion__ = "0x020501f0"
-__date__       = "2024-07-28"
+__version__    = "2.6b1"
+__hexversion__ = "0x020600b1"
+__date__       = "2024-11-12"
 __status__     = "Stable"
 __domain__     = "novelwriter.io"
 

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelwriter/assets/i18n/project_en_GB.json

@@ -14,6 +14,7 @@
   "Objects": "Objects",
   "Entities": "Entities",
   "Custom": "Custom",
+  "New Page": "New Page",
   "0": "Zero",
   "1": "One",
   "2": "Two",

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelwriter/assets/icons/typicons_dark/icons.conf

@@ -44,6 +44,7 @@ cls_template    = mixed_document-new.svg
 cls_timeline    = typ_calendar.svg
 cls_trash       = typ_trash.svg
 cls_world       = typ_location.svg
+copy            = mixed_copy.svg
 cross           = typ_times.svg
 document        = typ_document.svg
 down            = typ_chevron-down.svg

novelwriter-2.6b1/novelwriter/assets/icons/typicons_dark/mixed_copy.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="m7.8824 2c-1.2988 0-2.3529 1.0541-2.3529 2.3529v2.3529h-1.1765c-1.2988 0-2.3529 1.0541-2.3529 2.3529v10.588c0 1.2988 1.0541 2.3529 2.3529 2.3529h10.588c1.2988 0 2.3529-1.0541 2.3529-2.3529v-1.1765h2.3529c1.2988 0 2.3529-1.0541 2.3529-2.3529v-11.765c0-1.2988-1.0541-2.3529-2.3529-2.3529zm0 2.3529h11.765v11.765h-2.3529v-7.0588c0-1.2988-1.0541-2.3529-2.3529-2.3529h-7.0588zm-3.5294 4.7059h10.588c0.32353 0 0-0.32353 0 0v10.588h-10.588v-9.8943z" fill="#69c" stroke-width="1.1765"/>
+</svg>

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelwriter/assets/icons/typicons_light/icons.conf

@@ -44,6 +44,7 @@ cls_template    = mixed_document-new.svg
 cls_timeline    = typ_calendar.svg
 cls_trash       = typ_trash.svg
 cls_world       = typ_location.svg
+copy            = mixed_copy.svg
 cross           = typ_times.svg
 document        = typ_document.svg
 down            = typ_chevron-down.svg

novelwriter-2.6b1/novelwriter/assets/icons/typicons_light/mixed_copy.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="m7.8824 2c-1.2988 0-2.3529 1.0541-2.3529 2.3529v2.3529h-1.1765c-1.2988 0-2.3529 1.0541-2.3529 2.3529v10.588c0 1.2988 1.0541 2.3529 2.3529 2.3529h10.588c1.2988 0 2.3529-1.0541 2.3529-2.3529v-1.1765h2.3529c1.2988 0 2.3529-1.0541 2.3529-2.3529v-11.765c0-1.2988-1.0541-2.3529-2.3529-2.3529zm0 2.3529h11.765v11.765h-2.3529v-7.0588c0-1.2988-1.0541-2.3529-2.3529-2.3529h-7.0588zm-3.5294 4.7059h10.588c0.32353 0 0-0.32353 0 0v10.588h-10.588v-9.8943z" fill="#4271ae" stroke-width="1.1765"/>
+</svg>

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelwriter/assets/themes/default_light.conf

@@ -29,5 +29,5 @@ helptext        =  92,  92,  92
 fadedtext       = 108, 108, 108
 errortext       = 255,  92,  92
 statusnone      = 120, 120, 120
-statussaved     = 200,  15,  39
-statusunsaved   =   2, 133,  37
+statussaved     =   2, 133,  37
+statusunsaved   = 200,  15,  39

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelwriter/common.py

@@ -29,6 +29,7 @@ import unicodedata
 import uuid
 import xml.etree.ElementTree as ET
 
+from collections.abc import Callable
 from configparser import ConfigParser
 from datetime import datetime
 from pathlib import Path
@@ -204,6 +205,14 @@ def checkIntTuple(value: int, valid: tuple | list | set, default: int) -> int:
     return default
 
 
+def firstFloat(*args: Any) -> float:
+    """Return the first value that is a float."""
+    for arg in args:
+        if isinstance(arg, float):
+            return arg
+    return 0.0
+
+
 ##
 #  Formatting Functions
 ##
@@ -406,6 +415,10 @@ def numberToRoman(value: int, toLower: bool = False) -> str:
     return roman.lower() if toLower else roman
 
 
+##
+#  Qt Helpers
+##
+
 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()})"
@@ -421,6 +434,13 @@ def describeFont(font: QFont) -> str:
     return "Error"
 
 
+def qtLambda(func: Callable, *args: Any, **kwargs: Any) -> Callable:
+    """A replacement for Python lambdas that works for Qt slots."""
+    def wrapper(*a_: Any) -> None:
+        func(*args, **kwargs)
+    return wrapper
+
+
 ##
 #  Encoder Functions
 ##
@@ -472,6 +492,10 @@ def jsonEncode(data: dict | list | tuple, n: int = 0, nmax: int = 0) -> str:
     return "".join(buffer)
 
 
+##
+#  XML Helpers
+##
+
 def xmlIndent(tree: ET.Element | ET.ElementTree) -> None:
     """A modified version of the XML indent function in the standard
     library. It behaves more closely to how the one from lxml does.
@@ -515,6 +539,45 @@ def xmlIndent(tree: ET.Element | ET.ElementTree) -> None:
     return
 
 
+def xmlElement(
+    tag: str,
+    text: str | int | float | bool | None = None,
+    *,
+    attrib: dict | None = None,
+    tail: str | None = None,
+) -> ET.Element:
+    """A custom implementation of Element with more arguments."""
+    xSub = ET.Element(tag, attrib=attrib or {})
+    if text is not None:
+        if isinstance(text, bool):
+            xSub.text = str(text).lower()
+        else:
+            xSub.text = str(text)
+    if tail is not None:
+        xSub.tail = tail
+    return xSub
+
+
+def xmlSubElem(
+    parent: ET.Element,
+    tag: str,
+    text: str | int | float | bool | None = None,
+    *,
+    attrib: dict | None = None,
+    tail: str | None = None,
+) -> ET.Element:
+    """A custom implementation of SubElement with more arguments."""
+    xSub = ET.SubElement(parent, tag, attrib=attrib or {})
+    if text is not None:
+        if isinstance(text, bool):
+            xSub.text = str(text).lower()
+        else:
+            xSub.text = str(text)
+    if tail is not None:
+        xSub.tail = tail
+    return xSub
+
+
 ##
 #  File and File System Functions
 ##

{novelwriter-2.5.1 → novelwriter-2.6b1}/novelwriter/config.py

@@ -161,8 +161,9 @@ class Config:
 
         self.dialogStyle     = 2        # Quote type to use for dialogue
         self.allowOpenDial   = True     # Allow open-ended dialogue quotes
-        self.narratorBreak   = ""       # Symbol to use for narrator break
         self.dialogLine      = ""       # Symbol to use for dialogue line
+        self.narratorBreak   = ""       # Symbol to use for narrator break
+        self.narratorDialog  = ""       # Symbol for alternating between dialogue and narrator
         self.altDialogOpen   = ""       # Alternative dialog symbol, open
         self.altDialogClose  = ""       # Alternative dialog symbol, close
         self.highlightEmph   = True     # Add colour to text emphasis
@@ -252,6 +253,10 @@ class Config:
     def hasError(self) -> bool:
         return self._hasError
 
+    @property
+    def locale(self) -> QLocale:
+        return self._dLocale
+
     @property
     def recentProjects(self) -> RecentProjects:
         return self._recentProjects
@@ -653,10 +658,11 @@ class Config:
         self.showFullPath    = conf.rdBool(sec, "showfullpath", self.showFullPath)
         self.dialogStyle     = conf.rdInt(sec, "dialogstyle", self.dialogStyle)
         self.allowOpenDial   = conf.rdBool(sec, "allowopendial", self.allowOpenDial)
+        self.dialogLine      = conf.rdStr(sec, "dialogline", self.dialogLine)
         self.narratorBreak   = conf.rdStr(sec, "narratorbreak", self.narratorBreak)
+        self.narratorDialog  = conf.rdStr(sec, "narratordialog", self.narratorDialog)
         self.altDialogOpen   = conf.rdStr(sec, "altdialogopen", self.altDialogOpen)
         self.altDialogClose  = conf.rdStr(sec, "altdialogclose", self.altDialogClose)
-        self.dialogLine      = conf.rdStr(sec, "dialogline", self.dialogLine)
         self.highlightEmph   = conf.rdBool(sec, "highlightemph", self.highlightEmph)
         self.stopWhenIdle    = conf.rdBool(sec, "stopwhenidle", self.stopWhenIdle)
         self.userIdleTime    = conf.rdInt(sec, "useridletime", self.userIdleTime)
@@ -762,10 +768,11 @@ class Config:
             "showfullpath":    str(self.showFullPath),
             "dialogstyle":     str(self.dialogStyle),
             "allowopendial":   str(self.allowOpenDial),
+            "dialogline":      str(self.dialogLine),
             "narratorbreak":   str(self.narratorBreak),
+            "narratordialog":  str(self.narratorDialog),
             "altdialogopen":   str(self.altDialogOpen),
             "altdialogclose":  str(self.altDialogClose),
-            "dialogline":      str(self.dialogLine),
             "highlightemph":   str(self.highlightEmph),
             "stopwhenidle":    str(self.stopWhenIdle),
             "useridletime":    str(self.userIdleTime),