Novelwriter

**Bugfixes**

* The modality of the dialogs have been made more consistent and a few issues with conflicting
settings resolved. Mostly the latter relates to some dialogs both having the `exec_()` call and
the `show()` call. The former implies modal, the latter does not, and the latter usually took
precedence. All dialogs are now modal with the exception of the Writing Statistics and Build
Novel Project tools. PR 389.

**User Interface**

* The Help menu entries for the documentation have been improved a bit. If the local copy of the
documentations is present (both files are checked now), and the Qt Assistant is installed, the
"Documentation (Local)" entry is visible with `F1` as keyboard shortcut. The "Documentation
(Online)" is always visible with `Shift+F1` keyboard shortcut. The `F1` key redirects to this too
if the local copy isn't available. PR 386.
* The Writing Statistics tool now has the ability to set a cap between 100 and 100 000 words on the
word count histogram bars. This is useful if the user has added a large chunk of text, in which
case the histogram bar is dominated by this one entry. Now, anything on and above the cap value
will have a full bar, and all other entries scale from 0 to the cap value. PR 387.

**Documentation**

* The main index page of the documentation now has a build date on it. PR 390.

**Other Changes**

* The Travis CI build system has been altered to first check that the tests pass for Python 3.8,
for then to move to the other supported Python versions. These are currently 3.6 and 3.7. Python
3.9 will be added when it is released in October. PR 388.
* Some clean-up of the source code, mostly in terms of unused imports and missing docstrings.
PR 391.

----

Note: The source code has now switched to a default branch named `main` ahead of the changes
planned by GitHub. See their [notes](https://github.com/github/renaming) for more information.

**Bugfixes**

* The `pytest` config file now sets the local source path as the first search path for the main
novelWriter package. This ensures that the tests can always find the correct version of the code
when running tests. PR 381.
* The `install.py` script was expecting an older file layout for assets files. This has now been
updated to the curren file layout. PR 380.

**User Interface**

* A set of new exception handling functions have been added. Recoverable errors will now pop an
error dialog with the error message and a traceback for the user. The application will not
generally exit on such errors, unless it causes Python itself to abort. It is possible to copy
and paste the error message so it can be used for a ticket in the issue tracker. PRs 376 and
378.

**Documentation**

* The full documentation for novelWriter, available at
[novelwriter.readthedocs.io](https://novelwriter.readthedocs.io/) has been rewritten. It was
drifting out of sync with the development of the code. In addition, many improvements have been
made to the reStructuredText formatting of the documentation source by providing better
cross-reference linking and highlighting. The main repository README file has been updated to
match. PRs 375, 382, and 384.
* The main `setup.py` script has been updated to also build documentation for the Qt Assistant when
given a `qthelp` flag. The compiled help files are copied into the `nw/assets/help` folder, and
bundled with the source when pushed to PyPi. The GUI has been altered to open the local help
files instead of redirecting to the online documentation if the local files are both present and
the Qt Assistant is installed. PR 375 and 379.

**Other Changes**

* Some minor changes to the source code has been made to more correctly use the Python
`__package__` variable. PR 376.

----

**Bugfixes**

* Fixed a crash when using the replace part of search/replace when using regular expressions for
the search. The replace code assumed the search field was a string, which isn't the case when
using RegEx, rather itb is a QRegularExpression or QRegExp object. This has now been resolved. In
addition, the replace feature has been improved to make sure that it only replaces text selected
by an actual search, not any user selected text. Issue 371, PRs 372 and 373.
* The Tokenizer class used for converting novelWriter markdown to other formats produced some
invalid escape sequence warnings. The warnings did not seem to affect the results, but have
nevertheless been fixed. PR 370.

**Features**

* Insert menu entries to insert single and double open and close quote symbols have been added.
These are the symbols selected as the quote symbols in Preferences. They also have keyboard
shortcuts associated with them. PR 367.

----

**Bugfixes**

* Any error encountered when converting a project from the old project folder structure to the new
were not properly propagated to the origin of the call. Any errors of warnings occurring in the
process would previously not have been reported properly. These are no reported in a pop-up
dialog. PR 359.

**User Interface**

* The tooltip of the search/replace Regular Expression option has been updated to state the feature
only works for Qt 5.3 or higher. PR 359.
* The menus have been restructured a bit. The search options have been moved to a new Search menu.
The menu order has been changed to a more standard order. The Build Novel Project tool moved to
the Tools menu. The full screen distraction free mode is now named Focus Mode everywhere in the
GUI, source code and settings files. Previously, different names were used in different places.
PR 361.
* Tooltips have been added to main GUI buttons without a button text. PRs 361 and 363.

**Features**

* The search/replace Regular Expression option now uses the newest QRegularExpression tool instead
of the older QRegExp tool if the Qt version is 5.13 or above. Otherwise, it still uses the old.
The main benefit of the newer tool in this context is better Unicode support. PR 360.
* The Build Novel Project tool can now generate Roman numbers for chapter markers. Both upper and
lower case is supported. PRs 362 and 363.

**Other Changes**

* The install scripts now try to create folders before copying icons. PR 364.
* The manifest file now lists the root assets folder, so that it is included in the PyPi build.
PR 364.
* The .desktop template file has the correct categories set according to the FreeDesktop standard.
PR 364.

----

**Note:** If the project file is opened by this version of novelWriter, the project file can no
longer be read by an earlier version due to the change of how autoReplace settings are stored.

**User Interface**

* The Session Log dialog, now named Writing Statistics, has been redesigned and now has a few more
filter options. This update also fixes the filtered time count properly. The dialog now shows a
histogram of words added in a given session, or optionally, on a given date. The filtered log
data can also be saved as a JSON or CSV file, the latter suitable for importing to a spread
sheet. The new dialog tool required a new session log file format, so the new session log has
been given a new file name. The old log file will be left untouched in the project's `meta`
folder. For projects created prior to this change, the log will record a word count offset that
will be subtracted from the first entry such that the first word diff will always be 1 instead of
the total word count of the entire project. Such a large word diff would otherwise saturate the
histogram. PRs 339 and 349.
* The document editor panel has received a footer bar like the one recently added to the document
view panel. The footer bar currently shows the status level of the document, and the document
word count. In addition, the word counter shows the change in count for the current session in
the same way project word count and change is shown in the status bar. The document word count
has been removed from the main window status bar. PR 348.
* The document editor footer can optionally be hidden in Distraction Free mode. PR 351.
* The Italic and Bold menu entries have been renamed to Emphasis and Strong Emphasis, which is more
in line with what they represent in Markdown and HTML. They are still rendered as Italic and
Bold in the document viewer, but the HTML export is using the `<em>` and `<strong>` tags.
PR 350.
* Due to several issues with the formatting of emphasised text using `*`, `**`, and `***` wrappers,
especially when using nested emphasis, the syntax for emphasis (italic) and strong (bold) has
been reverted to use `_` and `**` wrapping, respectively. This removes the ambiguity, and
resolves the corner cases. It was possible to resolve the issues by using a custom written parser
that takes care of all valid combinations, but such a parser would be a bit too slow for use in
syntax highlighting. I decided therefore to stick with RegEx parsing, and keeping those RegExes
as short and fast as possible while enforcing the basic formatting rules. Separating the notation
for emphasis and strong is commonly recommended when writing Markdown anyway, so it is a sensible
compromise between speed and flexibility. This PR partially reverses PR 310. Issue 353,
PR 355.
* The syntax highlighter now properly highlights overlapping formatting, including emphasised text
inside of highlighted quotes. PR 355.
* The colour highlighting of emphasis, strong and strike through, can now be switch off in
Preferences. The syntax highlighter will still apply the italic, bold and strike effects.
PR 357.
* The project path in the Details tab of Project Settings can now be selected and copied to
clipboard. Issue 354, PR 356.

**Other Changes**

* The way the auto-replace settings are stored in the project XML file has been changed in order to
be more consistent with other features, and to avoid a potential pitfall in defining the tag name
from a user-entered string. The project class retains its ability to read the old format of the
file, and will save in the new format. The file format of the project XML file has been bumped to
1.2. PRs 344, 346 and 347.

----

**Bugfixes**

* The project tree word counts were getting mixed up when a file was moved to the trash folder, or
permanently deleted. This has now been fixed, and moving a file should give a zero net change of
project word count. Permanently deleting it will result in a negative net change. Issue 333,
PR 335.

**User Interface**

* There is a feature in the project tree class that ensures that the tree item being acted on is
visible in the tree. It is called when you for instance click the header of an open document. It
was also activated when opening a document from the tree view with either double-click by mouse,
or by using the Enter key. This meant that the tree view would often move, which made it hard to
mouse click on items after each other since you ended up chasing a moving target. This feature is
now disabled for document open. In addition, the scroll into view feature has been added to the
search/replace call to move into the next document when reaching the end of the current document.
This was requested in Issue 332. PR 334.
* The Build Novel Project tool will now display the build time of the document in the preview
window in order for the user to know if it is potentially out of date. The timestamp is given, as
well as a fuzzy time string, indicating the age of the content. Issue 331, PRs 336 and 337.

**Documentation**

* The documentation has been updated to clarify the correct formatting for italic, bold and
strike through formatting tags. Issue 220, PR 338.

----