Updated changelog and release notes

2021-03-28 17:54:22 +02:00
parent c23ec06ce6
commit 38ba214327
4 changed files with 163 additions and 97 deletions
@@ -1,5 +1,56 @@
 # novelWriter Changelog
 ## Version 1.3 Beta 1 [2021-03-28]
 ### Release Notes
 This is a pre-release of 1.3. The primary feature of release 1.3 is the addition of
 internationalisation (i18n) of novelWriter. The release introduces support for Portuguese, French,
 and Norwegian in addition to the default English.
 This is a beta release. Use with caution on live project.
 ### Detailed Changelog
 **Internationalisation**
 * Added support to the source code for internationalisation of the GUI. Thanks to Bruno Meneguello
  (@bkmeneguello) for doing most of the work. Issue #93. PRs #673, #680, and #684.
 * Build Novel Project localisation has been added as well. This is separate from the GUI
  localisation as the project may not be written in the same language as the GUI is set to. PRs
  #676 and #682.
 * The text editor's auto-replace features now support inserting spaces automatically when replacing
  quotes, as well as in front of major punctuation. These features are common for writing tools
  supporting French and Spanish for instance. Issue #703. PR #704.
 **User Interface**
 * The Preferences dialog has been updated to be more responsive to varying text label lengths due
  to different needs for different languages. PRs #687 and #711.
 * The Project Settings dialog has been improved to be more consistent and user friendly across the
  Status, Importance and Auto-Replace tabs. Issue #691. PR #695.
 * The About dialog has been updated to contain more information on contributions. PR #698.
 **Translations**
 * Portuguese translation added by Bruno Meneguello (@bkmeneguello). PRs #673, #681, #686, and #697.
 * Norwegian translation added by Veronica Olsen (@vkbo). PR #679.
 * German translation added (Build tool only) by Marian Lückhof (@Number042). PR #683.
 * French translation added by Jan Lüdke (@jyhelle). PRs #692, #711, and #713.
 * American English added by Veronica Olsen (@vkbo). PR #693.
 **Installation**
 * Added i18n support to the setup script. PRs #673 and #729.
 **Code Maintainance**
 * The ISO lookup dictionary for language codes has been removed and replaced with the lookup
  features available in Qt5 through QLocal. The remaining two source files in the constants folder
  have been moved up a level as well. PRs #673 and #730.
 ----
 ## Version 1.2.2 [2021-03-28]
 ### Release Notes
@@ -2,103 +2,14 @@
 <html>
 <body>
-
+<h2>Release Notes for 1.3 Beta 1</h2>
 <h2>Release Notes for 1.2.2</h2>
 <p><i>Released on 28 March 2021</i></p>
-<p>This patch release is a bug fix release addressing some inconsistencies and issues with the
+<p>This is a pre-release of 1.3. The primary feature of release 1.3 is the addition of
-document header buttons when Focus Mode is active. The keyboard shortcuts for search and replace
+internationalisation (i18n) of novelWriter. The release introduces support for Portuguese, French,
-should now also work in Focus Mode. In addition, the setup script for novelWriter has been improved
+and Norwegian in addition to the default English.</p>
-when installing on Windows.</p>
+<p>This is a beta release. Use with caution on live project.</p>
 <p><i>See also the <a href="https://github.com/vkbo/novelWriter/releases">Releases</a> page.</i></p>
 <hr/>
 <h2>Release Notes for 1.2.1</h2>
 <p><i>Released on 21 March 2021</i></p>
 <p>This patch release is a bug fix release addressing issues with the document editor's search and
 replace tool. Due to some recently added restrictions on when various tools are active, depending
 on which part of the main window has the user's focus, the search tool keyboard shortcuts and
 buttons were blocked when they shouldn't. This release resolves these issues.</p>
 <hr/>
 <h2>Release Notes for 1.2</h2>
 <p><i>Released on 14 March 2021</i></p>
 <p>This release is mainly focused on the Build Novel Project tool. Completely new export classes
 have been written to support Open Document and Markdown exports. In addition, the way document
 layouts are handled have been automated a little to assist the user in keeping header levels and
 document layout flags in sync. The third new additoion is the ability to record and log idle time
 during a writing session to improve the writing statistics information as requested by several
 users. Finally, it is now possible to directly edit the project dictionary via a new, simple GUI
 dialog.</p>
 <h3>The Build Novel Project Tool</h3>
 <p>The main changes for this release are to the Build Novel Project tool. The Open Document export,
 as well as the Markdown export, is now handled entirely by code written for novelWriter.
 Previously, these export features depended on the underlying Qt library's save routines connected
 to the preview document shown in the build dialog. Using this method of export both meant that the
 content of the document was dependent on the preview being generated first, and it also meant that
 the exported document had limited support for novelWriter-specific features and custom formatting.
 The new export class should generate a much better result, especially for the Open Document
 formats. The Open Document standard is supported by Open Office, Libre Office, Google Docs,
 Microsoft Word, and probably a number of other applications too. The Markdown export hasn't changed
 a lot, but should be a slight improvement on the previous export feature.</p>
 <p>These changes to the build tool also imply that the saving process is now independent of the
 content of the preview window, meaning you don't have to rebuild the preview before saving, which
 was previously the case. To make this more consistent, the PDF export option has been moved to the
 print button as it is actually a print-to-file feature under the hood, not technically a proper PDF
 export format. It is exactly the same as printing to file from the print preview dialog.</p>
 <p>In addition to the changes to the export features, the Build Novel Project tool now also has
 controls for line height, which applies to all rich text export formats, and the option to replace
 unicode characters with appropriate html entities for html export.</p>
 <h3>Document Layout Automation</h3>
 <p>Among other changes in this release are a few improvements to the process of creating and
 changing documents. When a new document is first created, the header is generated from the assigned
 label and layout.</p>
 <p>In addition, for some document layouts, when the user changes the header level of the first
 header of the document, the document layout setting is updated accordingly. This should reduce the
 need for the user to maintain two ways of assigning the role of a given document. This automation
 only applies to combinations of header level and current document layouts where there is no
 ambiguity. For instance, changing the header level in a "Scene" document from level 3 to 2 changes
 the document layout automatically to "Chapter". But changing the first header of a "Book" layout
 document from 1 to 2 does not change the document's layout as the "Book" layout is a generic
 document layout and it's perfectly reasonable for its first header to be a chapter header.</p>
 <p>Keep in mind that novelWriter treats documents with layout "Book", "Chapter" and "Scene" exactly
 the same during exports. The distinction is only meant as a way to indicate the purpose of a
 document in the project tree. This new automation is meant to assist in keeping this information up
 to date. The other layouts do have an effect on formatting during export, and are generally left
 alone.</p>
 <h3>The Session Timer and Idle Time</h3>
 <p>Another change that has been requested by a couple of users is to have the session timer in the
 status bar stop counting when the user is inactive (idle). This feature is optional, and can be
 controlled from Preferences. The definition of "idle" in this context is either that the user is
 active in a different application than novelWriter (loss of focus) or that the user has not made
 any changes to the current document for a given amount of time. The time threshold is by default
 five minutes, but can be altered in Preferences.</p>
 <p>In addition, the idle time is also recorded in the session log, and can be viewed in the Writing
 Statistics dialog and exported with the rest of the information. The idle time is recorder in the
 logs regardless of whether the status bar clock takes idle time into consideration or not. So even
 if you turn off the idle time switch in Preferences, the other idle time setting still affects the
 writing stats log entries.</p>
 <h3>Other Changes</h3>
 <p>The user dictionary of the project, where words added to the dictionary from the document editor
 go, can now be viewed and edited with a new "Project Word List" tool in the "Tools" menu.</p>
 <p>A small additional feature added is also the ability to undo the last move of an item in the
 project tree. The keyboard shortcut for this is `Ctrl+Shift+Z`, or it can be accessed from the
 menu. The feature can only undo the last move, but it includes both documents moved to trash, moves
 by up/down keypress or menu entries, and drag and drop moves.</p>
 <p>A new keyword has been added to mark characters in the story. The new keyword is intended to tag
 a character as the focus character for a chapter or scene. This is useful for stories where the
 point-of-view character and the focus character are different.</p>
 <p>Lastly, two bugfixes have been made as well. The Empty Trash feature was no longer working due
 to an earlier fix solving another issue. The feature has now been restored. In addition, the
 indexer now checks that a keyword (tag or reference) is valid before saving it to the index.
 Previously, an invalid keyword could be saved to the index and potentially crash the application.
 </p>
 </body>
 </html>
@@ -0,0 +1,104 @@
 <!DOCTYPE html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>
 <body>
 <h2>Release Notes for 1.2.2</h2>
 <p><i>Released on 28 March 2021</i></p>
 <p>This patch release is a bug fix release addressing some inconsistencies and issues with the
 document header buttons when Focus Mode is active. The keyboard shortcuts for search and replace
 should now also work in Focus Mode. In addition, the setup script for novelWriter has been improved
 when installing on Windows.</p>
 <p><i>See also the <a href="https://github.com/vkbo/novelWriter/releases">Releases</a> page.</i></p>
 <hr/>
 <h2>Release Notes for 1.2.1</h2>
 <p><i>Released on 21 March 2021</i></p>
 <p>This patch release is a bug fix release addressing issues with the document editor's search and
 replace tool. Due to some recently added restrictions on when various tools are active, depending
 on which part of the main window has the user's focus, the search tool keyboard shortcuts and
 buttons were blocked when they shouldn't. This release resolves these issues.</p>
 <hr/>
 <h2>Release Notes for 1.2</h2>
 <p><i>Released on 14 March 2021</i></p>
 <p>This release is mainly focused on the Build Novel Project tool. Completely new export classes
 have been written to support Open Document and Markdown exports. In addition, the way document
 layouts are handled have been automated a little to assist the user in keeping header levels and
 document layout flags in sync. The third new additoion is the ability to record and log idle time
 during a writing session to improve the writing statistics information as requested by several
 users. Finally, it is now possible to directly edit the project dictionary via a new, simple GUI
 dialog.</p>
 <h3>The Build Novel Project Tool</h3>
 <p>The main changes for this release are to the Build Novel Project tool. The Open Document export,
 as well as the Markdown export, is now handled entirely by code written for novelWriter.
 Previously, these export features depended on the underlying Qt library's save routines connected
 to the preview document shown in the build dialog. Using this method of export both meant that the
 content of the document was dependent on the preview being generated first, and it also meant that
 the exported document had limited support for novelWriter-specific features and custom formatting.
 The new export class should generate a much better result, especially for the Open Document
 formats. The Open Document standard is supported by Open Office, Libre Office, Google Docs,
 Microsoft Word, and probably a number of other applications too. The Markdown export hasn't changed
 a lot, but should be a slight improvement on the previous export feature.</p>
 <p>These changes to the build tool also imply that the saving process is now independent of the
 content of the preview window, meaning you don't have to rebuild the preview before saving, which
 was previously the case. To make this more consistent, the PDF export option has been moved to the
 print button as it is actually a print-to-file feature under the hood, not technically a proper PDF
 export format. It is exactly the same as printing to file from the print preview dialog.</p>
 <p>In addition to the changes to the export features, the Build Novel Project tool now also has
 controls for line height, which applies to all rich text export formats, and the option to replace
 unicode characters with appropriate html entities for html export.</p>
 <h3>Document Layout Automation</h3>
 <p>Among other changes in this release are a few improvements to the process of creating and
 changing documents. When a new document is first created, the header is generated from the assigned
 label and layout.</p>
 <p>In addition, for some document layouts, when the user changes the header level of the first
 header of the document, the document layout setting is updated accordingly. This should reduce the
 need for the user to maintain two ways of assigning the role of a given document. This automation
 only applies to combinations of header level and current document layouts where there is no
 ambiguity. For instance, changing the header level in a "Scene" document from level 3 to 2 changes
 the document layout automatically to "Chapter". But changing the first header of a "Book" layout
 document from 1 to 2 does not change the document's layout as the "Book" layout is a generic
 document layout and it's perfectly reasonable for its first header to be a chapter header.</p>
 <p>Keep in mind that novelWriter treats documents with layout "Book", "Chapter" and "Scene" exactly
 the same during exports. The distinction is only meant as a way to indicate the purpose of a
 document in the project tree. This new automation is meant to assist in keeping this information up
 to date. The other layouts do have an effect on formatting during export, and are generally left
 alone.</p>
 <h3>The Session Timer and Idle Time</h3>
 <p>Another change that has been requested by a couple of users is to have the session timer in the
 status bar stop counting when the user is inactive (idle). This feature is optional, and can be
 controlled from Preferences. The definition of "idle" in this context is either that the user is
 active in a different application than novelWriter (loss of focus) or that the user has not made
 any changes to the current document for a given amount of time. The time threshold is by default
 five minutes, but can be altered in Preferences.</p>
 <p>In addition, the idle time is also recorded in the session log, and can be viewed in the Writing
 Statistics dialog and exported with the rest of the information. The idle time is recorder in the
 logs regardless of whether the status bar clock takes idle time into consideration or not. So even
 if you turn off the idle time switch in Preferences, the other idle time setting still affects the
 writing stats log entries.</p>
 <h3>Other Changes</h3>
 <p>The user dictionary of the project, where words added to the dictionary from the document editor
 go, can now be viewed and edited with a new "Project Word List" tool in the "Tools" menu.</p>
 <p>A small additional feature added is also the ability to undo the last move of an item in the
 project tree. The keyboard shortcut for this is `Ctrl+Shift+Z`, or it can be accessed from the
 menu. The feature can only undo the last move, but it includes both documents moved to trash, moves
 by up/down keypress or menu entries, and drag and drop moves.</p>
 <p>A new keyword has been added to mark characters in the story. The new keyword is intended to tag
 a character as the focus character for a chapter or scene. This is useful for stories where the
 point-of-view character and the focus character are different.</p>
 <p>Lastly, two bugfixes have been made as well. The Empty Trash feature was no longer working due
 to an earlier fix solving another issue. The feature has now been restored. In addition, the
 indexer now checks that a keyword (tag or reference) is valid before saving it to the index.
 Previously, an invalid keyword could be saved to the index and potentially crash the application.
 </p>
 </body>
 </html>
@@ -1,13 +1,13 @@
 <?xml version='1.0' encoding='utf-8'?>
-<novelWriterXML appVersion="1.3a0" hexVersion="0x010300a0" fileVersion="1.2" timeStamp="2021-02-18 20:34:04">
+<novelWriterXML appVersion="1.3b1" hexVersion="0x010300b1" fileVersion="1.2" timeStamp="2021-03-28 17:53:43">
  <project>
    <name>Sample Project</name>
    <title>Sample Project</title>
    <author>Jane Smith</author>
    <author>Jay Doh</author>
-    <saveCount>1054</saveCount>
+    <saveCount>1057</saveCount>
    <autoCount>166</autoCount>
-    <editTime>49435</editTime>
+    <editTime>49506</editTime>
  </project>
  <settings>
    <doBackup>False</doBackup>