Merge release 2.5.2

.github/workflows/build_win.yml

@@ -28,7 +28,27 @@ jobs:
       - name: Build Setup Installer
         run: python pkgutils.py build-win-exe
 
-      - name: Upload Artifacts
+      - name: Upload Unsigned Artifacts
+        id: upload-unsigned-artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: Win-Setup
+          path: dist/*.exe
+          if-no-files-found: error
+          retention-days: 14
+
+      - name: Submit Signing Request
+        uses: signpath/github-action-submit-signing-request@v1
+        with:
+          api-token: "${{ secrets.SIGNPATH_API_TOKEN }}"
+          organization-id: "0471e52c-66fa-4e9a-bfb9-36167095ca3f"
+          project-slug: "novelWriter"
+          signing-policy-slug: "release-signing"
+          github-artifact-id: "${{ steps.upload-unsigned-artifact.outputs.artifact-id }}"
+          wait-for-completion: true
+          output-artifact-directory: "dist/"
+
+      - name: Upload Signed Artifacts
         uses: actions/upload-artifact@v4
         with:
           name: Win-Setup

CHANGELOG.md

@@ -1,5 +1,35 @@
 # novelWriter Changelog
 
+## 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

docs/source/usage_writing.rst

@@ -40,6 +40,24 @@ Any :term:`references<reference>` in the editor can be opened in the viewer by m
 the label and pressing :kbd:`Ctrl+Return`. You can also control-click them with your mouse.
 
 
+Spell Checking
+--------------
+
+A third party library called Enchant is used for spell checking in the editor. The controls for
+spell checking can be found in the **Tools** menu. You can also set spell checking language in
+**Project Settings**.
+
+This spell checking library comes with support for custom words that you can add by selecting
+"Add Word to Dictionary" from the context menu when a word is highlighted by the spell checker as
+misspelled. The custom words are managed on a per-project basis, and can the list of words can be
+edited from the **Project Word List** tool available from the **Tools** menu.
+
+.. note::
+
+   Generally, spell checking dictionaries are collected from your operating system, but on Windows
+   they are not. See :ref:`a_custom_dict` for how to add spell checking dictionaries on Windows.
+
+
 Editor Auto-Completer
 ---------------------
 

sample/nwProject.nwx

@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="2.5.1" hexVersion="0x020501f0" fileVersion="1.5" fileRevision="4" timeStamp="2024-07-21 20:05:31">
-  <project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="1955" autoCount="277" editTime="90998">
+<novelWriterXML appVersion="2.5.2" hexVersion="0x020502f0" fileVersion="1.5" fileRevision="4" timeStamp="2024-09-17 15:33:20">
+  <project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="1956" autoCount="277" editTime="91001">
     <name>Sample Project</name>
     <author>Jane Smith</author>
   </project>