Release 2.2 (#1641)

CHANGELOG.md

@@ -1,5 +1,105 @@
 # novelWriter Changelog
 
+## Version 2.2 [2023-12-17]
+
+### Release Notes
+
+This release comes with a number of new features. These are some highlights.
+
+In addition to the common Markdown style formatting for bold, italic and strike through, a set of
+new shortcodes have been added. The shortcodes are far more flexible than the Markdown style
+syntax, and can be used for more complex formatting cases. Like when you need to add multiple,
+overlapping formats, or add emphasis to just a part of a word. The shortcodes also allow for
+underline, subscript and superscript, which the Markdown syntax does not. The new formats are
+available in the "Format" menu, and in a new toolbar in the editor that can be enabled by clicking
+the three dots in the top--left corner. The shortcode format was chosen because it can later be
+extended to include other requested features as well. Please have a look at the documentation for
+more details about the new shortcodes.
+
+The Tags and References system has been improved. The tags themselves are no longer case sensitive
+when you use them in references, but they are still displayed as you typed them in the tag
+definition when they are displayed in the user interface. Starting to type the `@` symbol in the
+text editor, on a new line, will now open an auto-completer menu which will display available
+options. It may not display all of your tags if you have a lot of them, but starting to type more
+characters will filter the list down further.
+
+You can now automatically create a note file for a new tag that you have added to a reference list
+in a document, but is not yet defined in a project note. So, for instance, if you come up with a
+new character while writing, and add a new tag to your `@char` references, you can right-click the
+new tag and create a new note for that entry directly. In addition, it is now also possible to
+right-click a heading in an open document and set the item label in the project tree to match the
+heading.
+
+In addition to the changes in the editor, the "References" panel below the document viewer has also
+been completely redesigned. It now shows all the references to the document you are viewing as a
+list, with a lot more details than before. In addition, tabs in the panel will appear to show all
+the tags you have defined in your notes, sorted as one tab per category. Like for instance
+Characters, Locations, Objects, etc. You can also give each note a short description comment on the
+same format as the summary comments for chapters and scenes. The short description comment can be
+added from the "Insert" menu under "Special Comments".
+
+The last major change in this release is the new multi-select feature in the project tree. You can
+now select multiple documents and folders using the mouse while pressing `Ctrl` or `Shift`. By
+right-clicking the selected items, you can perform a limited set of operations on all of them, like
+changing active status, and the status or importance labels. You can also drag and drop multiple
+items under the condition that all the selected items are in the same folder, at the same level.
+This restriction is in place due to limitations in the framework novelWriter is based on. But this
+should help in cases where multiple documents need to be moved in and out of folders or between
+folders. Note that adding the multi-select feature meant that the undo feature of the project tree
+had to be removed. It may be added back later.
+
+_These Release Notes also include the changes from the 2.2 Beta 1 and 2.2 RC 1 releases._
+
+### Detailed Changelog
+
+**Bugfixes**
+
+* Fix column widths for columns with no text in the viewer panel lists, and fix an issues where
+  icons were not updated on theme switch. Issue #1627. PR #1626.
+* Fix auto-selection of words with apostrophes. Issue #1624. PR #1632.
+
+**Usability**
+
+* Use `Ctrl+K, H` for inserting short description comments (alias to synopsis), drop the space
+  after the `%` symbol when inserting special comments, add a browse icon to the open open project
+  dialog, and remove the popup warning for Alpha releases. PR #1626.
+* Menu entries no longer clear the status bar message when they are hovered. This was caused by a
+  status tip feature in Qt, which prints a blank message to the status bar. PR #1630.
+* The novel view panel now scrolls to bring the current document into view when iteratively
+  searching through documents in the project. Issue #1555. PR #1632.
+* The progress bar on the Manuscript Build dialog now stays for 3 seconds after completion instead
+  of 1 second. PR #1634.
+* The document viewer panel now shows the importance label next to each entry, and double-clicking
+  an entry will open it in the viewer. All entries also now show the content in tooltips so that
+  the columns can be shrunk to only view the icon if there is too little space. Issue #16220.
+  PR #1639.
+* The editor toolbar no longer uses the same buttons for markdown and shortcodes style formatting.
+  They have each received their separate buttons. Some additional space has been added between the
+  two types of buttons to visually separate them. Issues #1636 and #1637. PR #1638.
+* Convert the Synopsis and Comment buttons in the document viewer footer to buttons with both icon
+  and text, and drop the label. Issue #1628. PR #1638.
+
+**Internationalisation**
+
+* Updated US English, Norwegian, Japanese, Latin American Spanish, French, and Italian
+  translations. PRs #1625 and #1641.
+
+**Documentation**
+
+* The documentation has been updated to cover new features in 2.2. PR #1640.
+
+**Code Improvements**
+
+* Improve memory usage by making sure C++ objects are deleted when they are no longer used. There
+  is an issue between the Python and Qt side of things where objects are left in memory and not
+  properly garbage collected when they run out of scope. A number of deferred delete calls have
+  been added that seems to solve most of these cases. A `--meminfo` flag has been added to the
+  command line arguments to provide diagnostic data to help debug such issues. PR #1629.
+* Improve handling of alert boxes and their memory clean up, and refactor event filters. PR #1631.
+* Clean up unused methods in GUI extensions. PR #1634.
+
+----
+
 ## Version 2.2 RC 1 [2023-11-26]
 
 ### Release Notes

novelwriter/__init__.py

@@ -42,9 +42,9 @@ __license__    = "GPLv3"
 __author__     = "Veronica Berglyd Olsen"
 __maintainer__ = "Veronica Berglyd Olsen"
 __email__      = "code@vkbo.net"
-__version__    = "2.2-rc1"
-__hexversion__ = "0x020200c1"
-__date__       = "2023-11-26"
+__version__    = "2.2"
+__hexversion__ = "0x020200f0"
+__date__       = "2023-12-17"
 __status__     = "Stable"
 __domain__     = "novelwriter.io"
 

novelwriter/assets/text/release_notes.htm

@@ -2,14 +2,47 @@
 <html>
 <body>
 
-<h2>Release Notes for 2.2 RC 1</h2>
-<p><i>Released on 26 November 2023</i></p>
+<h2>Release Notes for 2.2</h2>
+<p><i>Released on 17 December 2023</i></p>
 
-<p>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.</p>
-<p>Please check the changelog for an overview of changes. The full release notes will be added to
-the final release.</p>
+<p>This release comes with a number of new features. These are some highlights.</p>
+<p>In addition to the common Markdown style formatting for bold, italic and strike through, a set
+of new shortcodes have been added. The shortcodes are far more flexible than the Markdown style
+syntax, and can be used for more complex formatting cases. Like when you need to add multiple,
+overlapping formats, or add emphasis to just a part of a word. The shortcodes also allow for
+underline, subscript and superscript, which the Markdown syntax does not. The new formats are
+available in the "Format" menu, and in a new toolbar in the editor that can be enabled by clicking
+the three dots in the top–left corner. The shortcode format was chosen because it can later be
+extended to include other requested features as well. Please have a look at the documentation for
+more details about the new shortcodes.</p>
+<p>The Tags and References system has been improved. The tags themselves are no longer case
+sensitive when you use them in references, but they are still displayed as you typed them in the
+tag definition when they are displayed in the user interface. Starting to type the '@' symbol in
+the text editor, on a new line, will now open an auto-completer menu which will display available
+options. It may not display all of your tags if you have a lot of them, but starting to type more
+characters will filter the list down further.</p>
+<p>You can now automatically create a note file for a new tag that you have added to a reference
+list in a document, but is not yet defined in a project note. So, for instance, if you come up with
+a new character while writing, and add a new tag to your '@char' references, you can right-click
+the new tag and create a new note for that entry directly. In addition, it is now also possible to
+right-click a heading in an open document and set the item label in the project tree to match the
+heading.</p>
+<p>In addition to the changes in the editor, the "References" panel below the document viewer has
+also been completely redesigned. It now shows all the references to the document you are viewing as
+a list, with a lot more details than before. In addition, tabs in the panel will appear to show all
+the tags you have defined in your notes, sorted as one tab per category. Like for instance
+Characters, Locations, Objects, etc. You can also give each note a short description comment on the
+same format as the summary comments for chapters and scenes. The short description comment can be
+added from the "Insert" menu under "Special Comments".</p>
+<p>The last major change in this release is the new multi-select feature in the project tree. You
+can now select multiple documents and folders using the mouse while pressing 'Ctrl' or 'Shift'. By
+right-clicking the selected items, you can perform a limited set of operations on all of them, like
+changing active status, and the status or importance labels. You can also drag and drop multiple
+items under the condition that all the selected items are in the same folder, at the same level.
+This restriction is in place due to limitations in the framework novelWriter is based on. But this
+should help in cases where multiple documents need to be moved in and out of folders or between
+folders. Note that adding the multi-select feature meant that the undo feature of the project tree
+had to be removed. It may be added back later.</p>
 
 <p><i>See also the <a href="https://github.com/vkbo/novelWriter/releases">Releases</a> page.</i></p>
 

novelwriter/common.py

@@ -3,7 +3,7 @@ novelWriter – Common Functions
 ==============================
 
 File History:
-Created: 2019-05-12 [0.1]
+Created: 2019-05-12 [0.1.0]
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/coretools.py

@@ -6,6 +6,7 @@ File History:
 Created: 2022-10-02 [2.0rc1] DocMerger
 Created: 2022-10-11 [2.0rc1] DocSplitter
 Created: 2022-11-03 [2.0rc2] ProjectBuilder
+Created: 2023-07-20 [2.1b1]  DocDuplicator
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/item.py

@@ -3,7 +3,7 @@ novelWriter – Project Item Class
 ================================
 
 File History:
-Created: 2018-10-27 [0.0.1]
+Created: 2018-10-27 [0.0.1] NWItem
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/options.py

@@ -3,8 +3,8 @@ novelWriter – Project Options Cache
 ===================================
 
 File History:
-Created:   2019-10-21 [0.3.1]
-Rewritten: 2020-02-19 [0.4.5]
+Created:   2019-10-21 [0.3.1] OptionState
+Rewritten: 2020-02-19 [0.4.5] OptionState
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/project.py

@@ -3,7 +3,7 @@ novelWriter – Project Wrapper
 =============================
 
 File History:
-Created: 2018-09-29 [0.0.1]
+Created: 2018-09-29 [0.0.1] NWProject
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/projectdata.py

@@ -3,7 +3,7 @@ novelWriter – Project Data Class
 ================================
 
 File History:
-Created: 2022-10-30 [2.0rc2]
+Created: 2022-10-30 [2.0rc2] NWProjectData
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/sessions.py

@@ -3,7 +3,7 @@ novelWriter – Project Session Log Class
 =======================================
 
 File History:
-Created:   2023-06-11 [2.1b1]
+Created: 2023-06-11 [2.1b1] NWSessionLog
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/spellcheck.py

@@ -3,7 +3,8 @@ novelWriter – Spell Check Classes
 =================================
 
 File History:
-Created: 2019-06-11 [0.1.5]
+Created: 2019-06-11 [0.1.5] NWSpellEnchant
+Created: 2023-06-13 [2.1b1] UserDictionary
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/status.py

@@ -3,8 +3,8 @@ novelWriter – Project Item Status Class
 =======================================
 
 File History:
-Created:   2019-05-19 [0.1.3]
-Rewritten: 2022-04-05 [2.0b1]
+Created:   2019-05-19 [0.1.3] NWStatus
+Rewritten: 2022-04-05 [2.0b1] NWStatus
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/tohtml.py

@@ -3,7 +3,7 @@ novelWriter – HTML Text Converter
 =================================
 
 File History:
-Created: 2019-05-07 [0.0.1]
+Created: 2019-05-07 [0.0.1] ToHtml
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/tomd.py

@@ -3,7 +3,7 @@ novelWriter – Markdown Text Converter
 =====================================
 
 File History:
-Created: 2021-02-06 [1.2b1]
+Created: 2021-02-06 [1.2b1] ToMarkdown
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/core/tree.py

@@ -3,7 +3,7 @@ novelWriter – Project Tree Class
 ================================
 
 File History:
-Created: 2020-05-07 [0.4.5]
+Created: 2020-05-07 [0.4.5] NWTree
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/about.py

@@ -3,7 +3,7 @@ novelWriter – GUI About Box
 ===========================
 
 File History:
-Created: 2020-05-21 [0.5.2]
+Created: 2020-05-21 [0.5.2] GuiAbout
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/docmerge.py

@@ -3,8 +3,8 @@ novelWriter – GUI Doc Merge Dialog
 ==================================
 
 File History:
-Created:   2020-01-23 [0.4.3]
-Rewritten: 2022-10-06 [2.0rc1]
+Created:   2020-01-23 [0.4.3]  GuiDocMerge
+Rewritten: 2022-10-06 [2.0rc1] GuiDocMerge
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/docsplit.py

@@ -3,8 +3,8 @@ novelWriter – GUI Doc Split Dialog
 ==================================
 
 File History:
-Created:   2020-02-01 [0.4.3]
-Rewritten: 2022-10-12 [2.0rc1]
+Created:   2020-02-01 [0.4.3]  GuiDocSplit
+Rewritten: 2022-10-12 [2.0rc1] GuiDocSplit
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/editlabel.py

@@ -3,7 +3,7 @@ novelWriter – Edit Label Dialog
 ===============================
 
 File History:
-Created: 2022-06-11 [2.0rc1]
+Created: 2022-06-11 [2.0rc1] GuiEditLabel
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/preferences.py

@@ -3,7 +3,7 @@ novelWriter – GUI Preferences
 =============================
 
 File History:
-Created: 2019-06-10 [0.1.5]
+Created: 2019-06-10 [0.1.5] GuiPreferences
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/projdetails.py

@@ -3,7 +3,7 @@ novelWriter – GUI Project Details
 =================================
 
 File History:
-Created: 2021-01-03 [1.1rc1]
+Created: 2021-01-03 [1.1rc1] GuiProjectDetails
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/projload.py

@@ -3,7 +3,7 @@ novelWriter – GUI Open Project
 ==============================
 
 File History:
-Created: 2020-02-26 [0.4.5]
+Created: 2020-02-26 [0.4.5] GuiProjectLoad
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/projsettings.py

@@ -3,7 +3,7 @@ novelWriter – GUI Project Settings
 ==================================
 
 File History:
-Created: 2018-09-29 [0.0.1]
+Created: 2018-09-29 [0.0.1] GuiProjectSettings
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/quotes.py

@@ -3,7 +3,7 @@ novelWriter – GUI Quotes Dialog
 ===============================
 
 File History:
-Created: 2020-06-18 [0.9]
+Created: 2020-06-18 [0.9.0] GuiQuoteSelect
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/updates.py

@@ -3,7 +3,7 @@ novelWriter – GUI Updates
 =========================
 
 File History:
-Created: 2021-08-21 [1.5b1]
+Created: 2021-08-21 [1.5b1] GuiUpdates
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/dialogs/wordlist.py

@@ -3,7 +3,7 @@ novelWriter – GUI User Wordlist
 ===============================
 
 File History:
-Created: 2021-02-12 [1.2rc1]
+Created: 2021-02-12 [1.2rc1] GuiWordList
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/gui/dochighlight.py

@@ -3,7 +3,8 @@ novelWriter – GUI Syntax Highlighter
 ====================================
 
 File History:
-Created: 2019-04-06 [0.0.1]
+Created: 2019-04-06 [0.0.1] GuiDocHighlighter
+Created: 2023-09-10 [2.2b1] TextBlockData
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/gui/editordocument.py

@@ -3,7 +3,7 @@ novelWriter – GUI Text Document
 ===============================
 
 File History:
-Created: 2023-09-07 [2.2b1]
+Created: 2023-09-07 [2.2b1] GuiTextDocument
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/gui/itemdetails.py

@@ -3,7 +3,7 @@ novelWriter – GUI Item Details Panel
 ====================================
 
 File History:
-Created: 2019-04-24 [0.0.1]
+Created: 2019-04-24 [0.0.1] GuiItemDetails
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/gui/mainmenu.py

@@ -3,7 +3,7 @@ novelWriter – GUI Main Menu
 ===========================
 
 File History:
-Created: 2019-04-27 [0.0.1]
+Created: 2019-04-27 [0.0.1] GuiMainMenu
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/gui/projtree.py

@@ -6,6 +6,7 @@ File History:
 Created: 2018-09-29 [0.0.1]  GuiProjectTree
 Created: 2022-06-06 [2.0rc1] GuiProjectView
 Created: 2022-06-06 [2.0rc1] GuiProjectToolBar
+Created: 2023-11-22 [2.2rc1] _TreeContextMenu
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/gui/sidebar.py

@@ -3,7 +3,7 @@ novelWriter – GUI Main Window SideBar
 =====================================
 
 File History:
-Created: 2022-05-10 [2.0rc1]
+Created: 2022-05-10 [2.0rc1] GuiSideBar
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/gui/statusbar.py

@@ -3,7 +3,7 @@ novelWriter – GUI Main Window Status Bar
 ========================================
 
 File History:
-Created: 2019-04-20 [0.0.1]
+Created: 2019-04-20 [0.0.1] GuiMainStatus
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/shared.py

@@ -3,7 +3,8 @@ novelWriter – Shared Data Class
 ===============================
 
 File History:
-Created: 2023-08-10 [2.1rc1]
+Created: 2023-08-10 [2.1rc1] SharedData
+Created: 2023-08-14 [2.1rc1] _GuiAlert
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/tools/dictionaries.py

@@ -3,7 +3,7 @@ novelWriter – GUI Dictionary Downloader
 =======================================
 
 File History:
-Created: 2023-11-19 [2.2rc1]
+Created: 2023-11-19 [2.2rc1] GuiDictionaries
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/tools/lipsum.py

@@ -3,7 +3,7 @@ novelWriter – Lorem Ipsum Tool
 ==============================
 
 File History:
-Created: 2022-04-02 [2.0rc1]
+Created: 2022-04-02 [2.0rc1] GuiLipsum
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/tools/projwizard.py

@@ -3,7 +3,7 @@ novelWriter – GUI New Project Wizard
 ====================================
 
 File History:
-Created: 2020-07-11 [0.10.1]
+Created: 2020-07-11 [0.10.1] GuiProjectWizard
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

novelwriter/tools/writingstats.py

@@ -3,7 +3,7 @@ novelWriter – GUI Writing Statistics
 ====================================
 
 File History:
-Created: 2019-10-20 [0.3]
+Created: 2019-10-20 [0.3.0] GuiWritingStats
 
 This file is a part of novelWriter
 Copyright 2018–2023, Veronica Berglyd Olsen

sample/nwProject.nwx

@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="2.2-rc1" hexVersion="0x020200c1" fileVersion="1.5" fileRevision="1" timeStamp="2023-11-26 14:25:29">
-  <project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="1615" autoCount="255" editTime="81229">
+<novelWriterXML appVersion="2.2" hexVersion="0x020200f0" fileVersion="1.5" fileRevision="1" timeStamp="2023-12-13 12:31:51">
+  <project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="1616" autoCount="255" editTime="81239">
     <name>Sample Project</name>
     <title>Sample Project</title>
     <author>Jane Smith</author>