Release 2.1 RC 1 (#1513)

CHANGELOG.md

@@ -1,5 +1,57 @@
 # novelWriter Changelog
 
+## Version 2.1 RC 1 [2023-08-31]
+
+### 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 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
+
+**Bugfixes**
+
+* Fixed an issue where closing modal dialogs would close their parent. Issue #1494. PR #1496.
+* The log output no longer prints an error message if the project does not have anything in its
+  custom dictionary. PR #1495.
+
+**Usability**
+
+* novelWriter will no longer try to restore full screen mode if full screen was activated when it
+  was last closed. This never worked right anyway. PR #1498.
+* There are several usability updates for the Build Settings tool. Please check the PR for details.
+  Some key changes are that the build dialogs are now children of the main GUI, so they can be
+  moved freely from each other. The Selection page has been given a new look that should hopefully
+  make it easier to understand, and the side bar for the tool has been redesigned. A few labels
+  have also been changed to be easier to understand. Issue #1497. PR #1499.
+* The alert and message boxes have been reimplemented with the full feature set of the Qt message
+  box dialog instead of using the quick access functions with limited functionality. PR #1501.
+* A project's spell check dictionary can now be set directly from the Tools menu. Issue #1260.
+  PR #1508.
+* The document details dialog box now shows a document's creation and update date if that has been
+  set. Issue #1423. PR #1510.
+* Moving the mouse wheel on any area within the border of the text editor or viewer will now scroll
+  the document. Issue #1425. PR #1511.
+
+**Code Improvements**
+
+* A new shared data instance now owns the Gui Theme, the Project class and holds a link to the main
+  Gui instance as well. This new class also handles message and alert boxes. The project instance
+  is now destroyed and recreated between each project close/open cycle. This should guard better
+  from project to project data leakage. PRs #1502 and #1504.
+* The spell checker instance has been moved to the new shared data instance where it is destroyed
+  and recreated together with the project instance. This blocks against bleed-through of the user's
+  custom dictionary. PR #1508.
+* Text hash (SHA1) and creation and update time stemps are now added to the document file's meta
+  data section. The hash is used to detect file changes outside of novelWriter while documents are
+  open. The old checker has been deleted. Issue #1423. PR #1509.
+
+----
+
 ## Version 2.1 Beta 1 [2023-07-30]
 
 ### Release Notes

docs/source/int_source.rst

@@ -136,12 +136,12 @@ the ``assets`` folder of the source. This file can be built from setup script by
 Building the Documentation
 ==========================
 
-A local copy of this documentation can be generated as HTML. This requires the following Python
+A local copy of this documentation can be generated as HTML. This requires installing some Python
 packages from PyPi:
 
 .. code-block:: bash
 
-   pip install furo sphinx
+   pip install -r docs/source/requirements.txt
 
 The documentation can then be built from the root folder in the source code by running:
 

docs/source/int_started.rst

@@ -186,7 +186,7 @@ command will not work in the command line window.
 
    Screenshot of the Python installer on Windows.
 
-When Python is installed, you should be able to run Python commands from the COmmand Prompt or
+When Python is installed, you should be able to run Python commands from the Command Prompt or
 from PowerShell. You can verify this by running:
 
 .. code-block:: bash

docs/source/usage_format.rst

@@ -109,7 +109,7 @@ background, depending on the selected theme.
 Text Emphasis
 =============
 
-A minimal set of text emphasis styles are supported.
+A minimal set of text emphasis styles are supported for text paragraphs.
 
 ``_text_``
    The text is rendered as emphasised text (italicised).
@@ -120,7 +120,7 @@ A minimal set of text emphasis styles are supported.
 ``~~text~~``
    Strikethrough text.
 
-In markdown guides it is often recommended to differentiate between strong importance and emphasis
+In Markdown guides it is often recommended to differentiate between strong importance and emphasis
 by using ``**`` for strong and ``_`` for emphasis, although Markdown generally also supports ``__``
 for strong and ``*`` for emphasis. However, since the differentiation makes the highlighting and
 conversion significantly simpler and faster, in novelWriter this is a rule, not just a
@@ -132,11 +132,20 @@ In addition, the following rules apply:
    itself. That is, ``**text**`` is valid, ``**text **`` is not.
 2. More generally, the delimiters must be on the outer edge of words. That is, ``some **text in
    bold** here`` is valid, ``some** text in bold** here`` is not.
-3. If using both ``**`` and ``_`` to wrap the same text, the underscore must be the inner wrapper.
-   This is due to the underscore also being a valid word character, so if they are on the outside,
-   they violate rule 2.
+3. If using both ``**`` and ``_`` to wrap the same text, the underscore must be the *inner*
+   wrapper. This is due to the underscore also being a valid word character, so if they are on the
+   outside, they violate rule 2.
 4. Text emphasis does not span past line breaks. If you need to add emphasis to multiple lines or
    paragraphs, you must apply it to each of them in turn.
+5. Text emphasis can only be used in plain paragraphs. Comments, titles, and meta data tags don't
+   allow for formatting, and any formatting markup will be renderred as-is.
+
+.. tip::
+
+   novelWriter supports standard escape syntax for the emphasis markup characters in case the
+   editor misunderstands your intended usage of them. That is, ``\*``, ``\_`` and ``\~`` will
+   generate a plain ``*``, ``_`` and ``~``, respectively, without interpreting them as part of the
+   markup.
 
 
 .. _a_fmt_comm:

docs/source/usage_interface.rst

@@ -204,6 +204,12 @@ match the word being replaced.
 The regular expression search is somewhat dependant on which version of Qt your system has. If you
 have Qt 5.13 or higher, there is better support for unicode symbols in the search.
 
+.. seealso::
+
+   For more information on the capabilities of the Regular Expression option, see the Qt
+   documentation for the `QRegularExpression <https://doc.qt.io/qt-5/qregularexpression.html>`_
+   class.
+
 
 .. _a_ui_edit_auto: