From 600e1cdbfbdb968eccab11aa2f1b12b2c754cb13 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Thu, 11 Feb 2021 17:04:48 +0100 Subject: [PATCH] Added release notes --- CHANGELOG.md | 70 +++++++++++++++++++++++ nw/assets/text/release_notes.htm | 84 ++++++++++++++++++++-------- nw/assets/text/release_notes_1.1.htm | 32 +++++++++++ sample/nwProject.nwx | 6 +- 4 files changed, 167 insertions(+), 25 deletions(-) create mode 100644 nw/assets/text/release_notes_1.1.htm diff --git a/CHANGELOG.md b/CHANGELOG.md index 46e948da..40cf45b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,76 @@ ### Release Notes +This release is a beta release of 1.2. The release is intended for testing of new features. There +is a higher risk of encountering bugs in a beta release than a final release, so be extra careful +with backups if used on active writing projects. + +#### The Build Novel Project Tool + +The main changes in 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, and that the exported document had +limited support for novelWriter-specific features and custom formatting. The new export tool 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. + +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. + +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. + +#### Document Layout Automation + +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. 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. + +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. + +#### The Session Timer and Idle Time + +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. This feature is optional, and can be controlled +from Preferences. The definition of idle here 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 +document open in the editor for a given amount of time. The time threshold is by default five +minutes, but can be altered in Preferences. + +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 displays this information or not. + +#### Other Changes + +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. + +Lastly, 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. + ### Detailed Changelog **New Features** diff --git a/nw/assets/text/release_notes.htm b/nw/assets/text/release_notes.htm index 92506344..6ce8bf2c 100644 --- a/nw/assets/text/release_notes.htm +++ b/nw/assets/text/release_notes.htm @@ -2,28 +2,68 @@
-Released on 7 February 2021
-The main change in this release is the addition of a new tab to the project tree on the left -side of the main window. The regular project tree is now on a tab named "Project", while a new tab -named "Novel" displays a simpler version of the information on the main "Outline" page. It lists -all the headers of the novel part of the project, as well as the word count and point-of-view -character of each section. This is an alternative way to navigate the novel part of the project. -The various tree views are now also kept better in sync when the user selects various documents and -headers.
-In addition, a new information dialog named "Project Details" has been added. It replaces the -"Details" tab in "Project Settings", and adds more information about the novel part of the project. -In particular, a "Table of Contents" in the "Contents" tab displays a summary of the main parts -and chapters of the project, their total word counts, and an estimated page count. This was made in -response to users asking for ways to estimate the total page count of the project. The page count -is estimated based on a words per page setting, which can be changed on the dialog window.
-Since the tabs below the project tree now add some extra room on the GUI, some convenient -buttons have been added in the same area, with direct access to "Project Details", "Writing -Statistics" and "Project Setting".
-A few other minor changes have been made as well. The Preferences dialog has been improved with -clearer categories and hopefully better help text. Some new options have been added too. They allow -syntax highlighting of multi-paragraph quotes. The highlighter can now optionally accept quotes to -be left "hanging", that is, no closing quote in the same paragraph.
+Released on 11 February 2021
+This release is a beta release of 1.2. The release is intended for testing of new features. +There is a higher risk of encountering bugs in a beta release than a final release, so be extra +careful with backups if used on active writing projects.
+ +The main changes in 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, and that the exported +document had limited support for novelWriter-specific features and custom formatting. The new +export tool 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.
+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.
+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.
+ +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. 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.
+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.
+ +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. This feature is optional, and can be controlled +from Preferences. The definition of idle here 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 +document open in the editor for a given amount of time. The time threshold is by default five +minutes, but can be altered in Preferences.
+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 displays this information or not.
+ +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.
+Lastly, 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.
The full changelog is available here.
diff --git a/nw/assets/text/release_notes_1.1.htm b/nw/assets/text/release_notes_1.1.htm new file mode 100644 index 00000000..92506344 --- /dev/null +++ b/nw/assets/text/release_notes_1.1.htm @@ -0,0 +1,32 @@ + + + + +Released on 7 February 2021
+The main change in this release is the addition of a new tab to the project tree on the left +side of the main window. The regular project tree is now on a tab named "Project", while a new tab +named "Novel" displays a simpler version of the information on the main "Outline" page. It lists +all the headers of the novel part of the project, as well as the word count and point-of-view +character of each section. This is an alternative way to navigate the novel part of the project. +The various tree views are now also kept better in sync when the user selects various documents and +headers.
+In addition, a new information dialog named "Project Details" has been added. It replaces the +"Details" tab in "Project Settings", and adds more information about the novel part of the project. +In particular, a "Table of Contents" in the "Contents" tab displays a summary of the main parts +and chapters of the project, their total word counts, and an estimated page count. This was made in +response to users asking for ways to estimate the total page count of the project. The page count +is estimated based on a words per page setting, which can be changed on the dialog window.
+Since the tabs below the project tree now add some extra room on the GUI, some convenient +buttons have been added in the same area, with direct access to "Project Details", "Writing +Statistics" and "Project Setting".
+A few other minor changes have been made as well. The Preferences dialog has been improved with +clearer categories and hopefully better help text. Some new options have been added too. They allow +syntax highlighting of multi-paragraph quotes. The highlighter can now optionally accept quotes to +be left "hanging", that is, no closing quote in the same paragraph.
+ +The full changelog is available +here.
+ + + diff --git a/sample/nwProject.nwx b/sample/nwProject.nwx index 9fc95dda..3e1756e3 100644 --- a/sample/nwProject.nwx +++ b/sample/nwProject.nwx @@ -1,13 +1,13 @@ -