From e9ed4a3f93fddd96e584782cd28c1900e2bad100 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sun, 31 Jan 2021 18:12:35 +0100 Subject: [PATCH] Updated changelog and added release notes --- CHANGELOG.md | 26 +++++ nw/__init__.py | 2 +- nw/assets/text/release_notes.htm | 139 +++++---------------------- nw/assets/text/release_notes_1.0.htm | 126 ++++++++++++++++++++++++ sample/nwProject.nwx | 6 +- 5 files changed, 179 insertions(+), 120 deletions(-) create mode 100644 nw/assets/text/release_notes_1.0.htm diff --git a/CHANGELOG.md b/CHANGELOG.md index 0bf1a1a2..1db8f462 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,32 @@ ### Release Notes +This is a preview and test release for version 1.1. + +A few new features have been added. The primary change is that the project tree on the left side of +the main window now has two tabs. The regular project tree is now on a tab named "Project", while a +new tab "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 the word count, and can be changed on the dialog window. + +Since the tabs below the project tree now adds some extra room on the GUI, some convenient buttons +have been added, 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. + ### Detailed Changelog **User Interface** diff --git a/nw/__init__.py b/nw/__init__.py index 059442a8..e6b02a39 100644 --- a/nw/__init__.py +++ b/nw/__init__.py @@ -66,7 +66,7 @@ __email__ = "code@vkbo.net" __version__ = "1.1rc1" __hexversion__ = "0x010100c1" __date__ = "2021-01-31" -__status__ = "Unstable" +__status__ = "Testing" __domain__ = "novelwriter.io" __url__ = "https://novelwriter.io" __sourceurl__ = "https://github.com/vkbo/novelWriter" diff --git a/nw/assets/text/release_notes.htm b/nw/assets/text/release_notes.htm index 7052b51c..d37dcf17 100644 --- a/nw/assets/text/release_notes.htm +++ b/nw/assets/text/release_notes.htm @@ -2,125 +2,32 @@
-Released on 24 January 2021
-This patch release fixes a minor bug sometimes encountered when running novelWriter from command -line on Windows. In addition, the Solarized Dark and Solarized Light themes have been added to the -selection of GUI and syntax themes by a user contribution.
-The main change in this release is to the install scripts and the documentation related to -installing and running novelWriter. The primary change is a different method of packaging the app -for Windows. Instead of building an .exe file, the new setup instead builds a runnable zip -file .pyz. The executable would often be mistakenly flagged by virus control software due to -the packaging tools. This is a known problem with pyinstaller and similar tools, but such warnings -are always concerning even if they are false positives.
+Released on 31 January 2021
+This is a preview and test release for version 1.1.
+A few new features have been added. The primary change is that the project tree on the left side +of the main window now has two tabs. The regular project tree is now on a tab named "Project", +while a new tab "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 the word count, and can be changed on the dialog window.
+Since the tabs below the project tree now adds some extra room on the GUI, some convenient +buttons have been added, 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.
-Released on 19 January 2021
-This patch release fixes a few minor cosmetic issues, a minor issue with the indexer, and a bug -when adding words to the user's own spell check dictionary. Additionally, the documentation has -been updated based on user feedback, and some install issues resolved.
- -Released on 10 January 2021
-This release is mainly to bring the documentation up to date, as I forgot to update the install -instructions in the original 1.0 release. I also forgot to change the various settings and help -texts that describe novelWriter as under initial development (beta state).
-Some minor improvements have been made to the "Edit Project Item" dialog and some restrictions -on the settings available for documents created in the "Outtakes" folder relaxed. A few minor -issues with the document and project changed icons on the status bar have also been resolved. The -indicators were previously set to changed status even if no actual change had been made to the -project.
- -Released on 3 January 2021
-Based on my own testing and usage, and no serious bugs discovered in quite some time (aside from -a few corner case issues), it appears that novelWriter is stable enough for a 1.0 release. Thanks -to all the new users who keep providing feedback on bugs, cosmetic issues, or suggesting -improvements and new features. I'm glad to hear that others find my application useful, and I will -keep making improvements as I get new suggestions and have new ideas myself. At the same time, I -will continue to keep novelWriter simple and clean and avoid feature-bloat.
-This release mainly fixes cosmetic and other minor issues to the user interface and makes a few -minor improvements to some less used features. Aside from this, nothing major has changed since the -last release candidate.
-This release concludes over two years of tinkering with this project. The project grew out of -numerous lunch and coffee discussions with my colleague Marian Lückhof at my former job. We were -both looking for a tool for writing novels on Linux that suited our needs. We started assembling a -wish list of features that has become novelWriter. In addition, users on GitHub have continued to -test new features, provide very helpful feedback, and make new suggestions for improvements. -Especially the feedback from @johnblommers has been helpful during much of the initial development -time. Over the last months more users have started posting ideas and feedback. Thanks to all of you -for your contributions.
-The 1.0 release is intended as a first release of the core features of novelWriter. That does -not mean that all planned features have been fully implemented. There is a long list of ideas and -suggestions to consider and implement. New ideas and suggestions are welcome. Either as feature -requests in the issue tracker, or if not fully formed, can be discussed on the -discussions page. - -
Released on 13 December 2020
-This second release candidate for 1.0 comes with only minor changes and improvements, and a -handful of minor bugfixes.
-Among the improvements is the addition of all the possible @-keywords for tags and references to -the "Insert" menu under the sub-menu "Tags and References". The "Help" menu has also received a few -improvements and additional links to useful webpages. This release also adds a "Release" notes tab -to the "About novelWriter" dialog. The release notes are displayed automatically the first time you -launch novelWriter after updating to a new version.
-Among the fixes is better support for high resolution screens. A few elements on the GUI did not -scale properly, among them the document editor and viewer header and footer. These were clipped on -high res screens due to an underlying issue with the Qt widget underestimating how much space it -required to accommodate the text. Unfortunately, dragging the novelWriter app between screens of -different scaling factors is not currently supported. However, the GUI should scale properly to the -scaling factor on the screen it is opened on.
-The work leading up to this release has mostly been focused on improving the test coverage of -the source code of novelWriter. This helps to ensure that the code does what it is intended to do, -and is able to handle corner cases and unexpected external errors and user actions that may occur. -While writing these tests, a number of minor potential issues have been uncovered and handled. Most -of these are corner cases that may not even be reachable by unexpected user actions.
-Hopefully, these changes have resulted in an even more stable version of novelWriter. If no more -issues are discovered, the next release will be the final version 1.0 release.
- -Released on 16 November 2020
-This is the first release candidate for the upcoming release of novelWriter 1.0.
-Since the fifth beta release about four weeks ago, not much has been changed in novelWriter. A -few minor tweaks have been made to the GUI.
-A number of features and tools are now automatically switched off when there is no project or -document open for those features to act upon. Previously, this was a bit inconsistent, although no -serious bugs have been reported or encountered.
-Most of the minor changes in this release should not be noticeable to most users. However, there -are a couple of noticeable changes.
-The "Typewriter Mode" of the editor has been improved. Essentially, this feature is a sort of -smart scroll. It tries to keep the cursor stationary in the vertical direction, and will try to -scroll the document up when the cursor skips to a new line while typing (or down in case of -backspaces). This is similar to the way a typewriter scrolls the paper when hitting the return key. -It improves the writing experience as the current active line will stay at the same eye height -level on the screen.
-Previously, the feature would lock the cursor to a given vertical position defined by the user. -Now, instead, the cursor will remain stationary in the vertical direction at any position the user -sets it to by mouse click or keyboard navigation. The user can define a minimum distance from the -top where this feature is activated. These changes makes it more flexible in terms of where the -focus is in the editor. The feature can be controlled from the main Preferences.
-It is now possible to switch syntax highlighting theme without restarting novelWriter. -Previously, changing the theme would only half-way update the document, header and footer -background and text colours. The new settings would not be fully applied until the application was -shut down and started again, thus making it a bit tedious to look through syntax themes to find the -one you want.
-Switching main GUI theme still requires a restart.
- diff --git a/nw/assets/text/release_notes_1.0.htm b/nw/assets/text/release_notes_1.0.htm new file mode 100644 index 00000000..7052b51c --- /dev/null +++ b/nw/assets/text/release_notes_1.0.htm @@ -0,0 +1,126 @@ + + + + +Released on 24 January 2021
+This patch release fixes a minor bug sometimes encountered when running novelWriter from command +line on Windows. In addition, the Solarized Dark and Solarized Light themes have been added to the +selection of GUI and syntax themes by a user contribution.
+The main change in this release is to the install scripts and the documentation related to +installing and running novelWriter. The primary change is a different method of packaging the app +for Windows. Instead of building an .exe file, the new setup instead builds a runnable zip +file .pyz. The executable would often be mistakenly flagged by virus control software due to +the packaging tools. This is a known problem with pyinstaller and similar tools, but such warnings +are always concerning even if they are false positives.
+ +The full changelog is available +here.
+ +Released on 19 January 2021
+This patch release fixes a few minor cosmetic issues, a minor issue with the indexer, and a bug +when adding words to the user's own spell check dictionary. Additionally, the documentation has +been updated based on user feedback, and some install issues resolved.
+ +Released on 10 January 2021
+This release is mainly to bring the documentation up to date, as I forgot to update the install +instructions in the original 1.0 release. I also forgot to change the various settings and help +texts that describe novelWriter as under initial development (beta state).
+Some minor improvements have been made to the "Edit Project Item" dialog and some restrictions +on the settings available for documents created in the "Outtakes" folder relaxed. A few minor +issues with the document and project changed icons on the status bar have also been resolved. The +indicators were previously set to changed status even if no actual change had been made to the +project.
+ +Released on 3 January 2021
+Based on my own testing and usage, and no serious bugs discovered in quite some time (aside from +a few corner case issues), it appears that novelWriter is stable enough for a 1.0 release. Thanks +to all the new users who keep providing feedback on bugs, cosmetic issues, or suggesting +improvements and new features. I'm glad to hear that others find my application useful, and I will +keep making improvements as I get new suggestions and have new ideas myself. At the same time, I +will continue to keep novelWriter simple and clean and avoid feature-bloat.
+This release mainly fixes cosmetic and other minor issues to the user interface and makes a few +minor improvements to some less used features. Aside from this, nothing major has changed since the +last release candidate.
+This release concludes over two years of tinkering with this project. The project grew out of +numerous lunch and coffee discussions with my colleague Marian Lückhof at my former job. We were +both looking for a tool for writing novels on Linux that suited our needs. We started assembling a +wish list of features that has become novelWriter. In addition, users on GitHub have continued to +test new features, provide very helpful feedback, and make new suggestions for improvements. +Especially the feedback from @johnblommers has been helpful during much of the initial development +time. Over the last months more users have started posting ideas and feedback. Thanks to all of you +for your contributions.
+The 1.0 release is intended as a first release of the core features of novelWriter. That does +not mean that all planned features have been fully implemented. There is a long list of ideas and +suggestions to consider and implement. New ideas and suggestions are welcome. Either as feature +requests in the issue tracker, or if not fully formed, can be discussed on the +discussions page. + +
Released on 13 December 2020
+This second release candidate for 1.0 comes with only minor changes and improvements, and a +handful of minor bugfixes.
+Among the improvements is the addition of all the possible @-keywords for tags and references to +the "Insert" menu under the sub-menu "Tags and References". The "Help" menu has also received a few +improvements and additional links to useful webpages. This release also adds a "Release" notes tab +to the "About novelWriter" dialog. The release notes are displayed automatically the first time you +launch novelWriter after updating to a new version.
+Among the fixes is better support for high resolution screens. A few elements on the GUI did not +scale properly, among them the document editor and viewer header and footer. These were clipped on +high res screens due to an underlying issue with the Qt widget underestimating how much space it +required to accommodate the text. Unfortunately, dragging the novelWriter app between screens of +different scaling factors is not currently supported. However, the GUI should scale properly to the +scaling factor on the screen it is opened on.
+The work leading up to this release has mostly been focused on improving the test coverage of +the source code of novelWriter. This helps to ensure that the code does what it is intended to do, +and is able to handle corner cases and unexpected external errors and user actions that may occur. +While writing these tests, a number of minor potential issues have been uncovered and handled. Most +of these are corner cases that may not even be reachable by unexpected user actions.
+Hopefully, these changes have resulted in an even more stable version of novelWriter. If no more +issues are discovered, the next release will be the final version 1.0 release.
+ +Released on 16 November 2020
+This is the first release candidate for the upcoming release of novelWriter 1.0.
+Since the fifth beta release about four weeks ago, not much has been changed in novelWriter. A +few minor tweaks have been made to the GUI.
+A number of features and tools are now automatically switched off when there is no project or +document open for those features to act upon. Previously, this was a bit inconsistent, although no +serious bugs have been reported or encountered.
+Most of the minor changes in this release should not be noticeable to most users. However, there +are a couple of noticeable changes.
+The "Typewriter Mode" of the editor has been improved. Essentially, this feature is a sort of +smart scroll. It tries to keep the cursor stationary in the vertical direction, and will try to +scroll the document up when the cursor skips to a new line while typing (or down in case of +backspaces). This is similar to the way a typewriter scrolls the paper when hitting the return key. +It improves the writing experience as the current active line will stay at the same eye height +level on the screen.
+Previously, the feature would lock the cursor to a given vertical position defined by the user. +Now, instead, the cursor will remain stationary in the vertical direction at any position the user +sets it to by mouse click or keyboard navigation. The user can define a minimum distance from the +top where this feature is activated. These changes makes it more flexible in terms of where the +focus is in the editor. The feature can be controlled from the main Preferences.
+It is now possible to switch syntax highlighting theme without restarting novelWriter. +Previously, changing the theme would only half-way update the document, header and footer +background and text colours. The new settings would not be fully applied until the application was +shut down and started again, thus making it a bit tedious to look through syntax themes to find the +one you want.
+Switching main GUI theme still requires a restart.
+ + + diff --git a/sample/nwProject.nwx b/sample/nwProject.nwx index 18579a3c..69bd2eee 100644 --- a/sample/nwProject.nwx +++ b/sample/nwProject.nwx @@ -1,13 +1,13 @@ -