From 35ec8e0f1295a835924d969a628ec5d2f01148f0 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Mon, 28 Nov 2022 17:12:48 +0100 Subject: [PATCH] Update release notes --- CHANGELOG.md | 94 ++++++++++++++++++++++- CONTRIBUTING.md | 4 +- novelwriter/assets/text/release_notes.htm | 86 +++++++++++++++++++-- sample/nwProject.nwx | 4 +- 4 files changed, 176 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 91b62eac..94067399 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,98 @@ ### Release Notes +This release includes a major update to the way your project is managed. It also modernises the +user interface. The project file format has also been updated, and your projects will be upgraded +the first time you open them in this release. + +There are some major changes under the hood in this release. A lot of the code has been rewritten +and split up into smaller components. A lot of this is to make it more efficient, but also to make +it more modular in preparation for planned future additions. Most of these changes don't affect you +as the user, but there are also a number of big feature changes that you will notice. + +#### User Interface Changes + +The tabs used to switch between the Project Tree and Novel Tree, as well as between the Editor and +Outline views, have been replaced with a side bar. The side bar is located on the left side of the +main window, and gives you the option to select between "Project Tree View", "Novel Tree View" and +"Outline Tree View". They correspond to the previous tabs. + +The side bar also includes a shortcut to the "Build Novel Project" tool. The "Project Details", +"Writing Statistics" and "Settings" buttons that were previously below the project tree are now +located at the bottom of the side bar. + +All three views have also been given updates. They each have a label and a toolbar. The Project +Tree View has a dropdown with quick links to all your root folders, which should make it easier to +navigate a large project tree. You can activate the link menu by pressing `Ctrl+L` while in the +Project Tree, so you don't need to move your mouse. + +A dropdown menu with all the options for adding new items to your project has also been added to +this toolbar. This too can be activated directly with a shortcut, `Ctrl+N`. More options are +available under the menu button, and there are also a set of move up and down buttons for moving +items. + +The Novel Tree View and Novel Outline View have also received toolbars and controls that let you +select which data to show, and customise the view. + +#### Changes to Project Structure + +A number of changes have been made to how you organise your project in the Project Tree View. For +instance, you are now allowed to add as many root folders as you want, and as many of each kind as +you want. Several users have asked for the ability to add multiple Novel folders, so the old +restriction of only one of each has been removed. + +You can now also move documents freely between all folders. The Status or Importance values will +switch place depending on the type of root folder your document is in, but the other value should +be preserved if you move the document back. Previously, they were saved as the same value in your +project, so moving them would imply they were overwritten. The new project file format introduced +with this release has no such restriction. + +Your documents are now also able to have other documents as child items. This is another feature +added based on feedback. You no longer need to make a chapter folder and add chapter files inside +it together with the scene documents. You can add the scene documents directly under the chapter +document and drop the folder entirely. If needed, you can convert an existing folder into a +document at any time. However, you are not allowed to convert a document into a folder. + +The check mark icon that previously indicated whether a document was included or not in a +manuscript build has been replaced with an active/inactive flag. This was done in preparation for +changes to the Build Novel Project tool which will come in the next release. The active/inactive +flag is now partially just an indicator to you as the writer whether the document is to be +considered a part of your project or not. That said, an inactive setting still causes it to be +excluded from the Novel Tree View and the Novel Outline View. + +The context (right click) menu for the Project Tree has also been updated. You can make nearly all +changes to the item directly from this menu, with the exception of editing the item label, which +still requires a dialog box. + +The Split and Merge tools have been rewritten from scratch. You should now have multiple options on +how to structure the resulting document or documents. You can access the new tools from the +"Transform" submenu when right-clicking a project item that supports splitting or merging. + +#### Novel and Outline View + +The Novel Tree View and Novel Outline View panels have been given a new design. The heading level +is now shown as an indent with a coloured bar that uses the same colour coding as the document +icons. They are technically no longer tree views, but rather a Table of Contents of a specific +novel root folder. If you have multiple novel root folders, you can select which one to view. + +In the Novel Tree View, you now also have the option to hide or show a third column of data. +Currently, you can chose between "Point of View Character", "Focus Character" and "Novel Plot". If +you referenced more than one in the document, the column will only show the first entry, so make +sure the most important one is listed first in your document if you use this feature. An arrow icon +is also visible at the end of each row in the tree, and if you click on it, a tool tip should pop +up showing you all the meta data collected for that specific heading in your text. + +#### Other Changes + +There has been a lot of changes under the hood as well, especially in regards to how the project +structure is handled and saved. The project index has also been almost completely rewritten, and +now collects information about your project more efficiently. This improves the way the project +tree determines which document icon to show you, and it also makes the Novel Tree View more +informative as the data there is updated a lot more frequently. + +The New Project Wizard has been updated with some new features, and simplified a bit. The Project +Settings dialog has been updated to reflect some of the same changes. + _These Release Notes also include the changes from 2.0 pre-releases._ ### Detailed Changelog @@ -37,7 +129,7 @@ _These Release Notes also include the changes from 2.0 pre-releases._ * The documentation has been updated to reflect 2.0 changes. Issue #1070, #1158 and #1181. PRs #1248 and #1255. -* Add project XML file format specification. Issue #1012. PR #1249. and #1254. +* Add project XML file format specification. Issue #1012. PRs #1249 and #1254. **Code Improvements** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd176d03..ac73aa1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,14 +98,14 @@ The `setup.cfg` file in the root of this project has the following settings for matches the above code style: ```conf [flake8] -ignore = E221,E226,E228,E241 +ignore = E133,E221,E226,E228,E241,W503 max-line-length = 99 exclude = docs/* ``` The command line equivalent, with reporting, is: ```bash -flake8 . --count --ignore E221,E226,E228,E241 --max-line-length=99 --show-source --statistics +flake8 . --count --ignore E133,E221,E226,E228,E241,W503 --max-line-length=99 --show-source --statistics ``` Passing this check is required before contributions are merged. This is checked automatically when diff --git a/novelwriter/assets/text/release_notes.htm b/novelwriter/assets/text/release_notes.htm index 5a529b14..1a23266c 100644 --- a/novelwriter/assets/text/release_notes.htm +++ b/novelwriter/assets/text/release_notes.htm @@ -2,14 +2,86 @@ -

Release Notes for 2.0 RC 2

-

Released on 13 November 2022

+

Release Notes for 2.0

+

Released on 4 December 2022

-

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.

-

Please check the changelog for an overview of changes. The full release notes will be added to -the final release.

+

This release includes a major update to the way your project is managed. It also modernises the +user interface. The project file format has also been updated, and your projects will be upgraded +the first time you open them in this release.

+

There are some major changes under the hood in this release. A lot of the code has been +rewritten and split up into smaller components. A lot of this is to make it more efficient, but +also to make it more modular in preparation for planned future additions. Most of these changes +don't affect you as the user, but there are also a number of big feature changes that you will +notice.

+ +

User Interface Changes

+

The tabs used to switch between the Project Tree and Novel Tree, as well as between the Editor +and Outline views, have been replaced with a side bar. The side bar is located on the left side of +the main window, and gives you the option to select between "Project Tree View", "Novel Tree View" +and "Outline Tree View". They correspond to the previous tabs.

+

The side bar also includes a shortcut to the "Build Novel Project" tool. The "Project Details", +"Writing Statistics" and "Settings" buttons that were previously below the project tree are now +located at the bottom of the side bar.

+

All three views have also been given updates. They each have a label and a toolbar. The Project +Tree View has a dropdown with quick links to all your root folders, which should make it easier to +navigate a large project tree. You can activate the link menu by pressing `Ctrl+L` while in the +Project Tree, so you don't need to move your mouse.

+

A dropdown menu with all the options for adding new items to your project has also been added to +this toolbar. This too can be activated directly with a shortcut, `Ctrl+N`. More options are +available under the menu button, and there are also a set of move up and down buttons for moving +items.

+

The Novel Tree View and Novel Outline View have also received toolbars and controls that let you +select which data to show, and customise the view.

+ +

Changes to Project Structure

+

A number of changes have been made to how you organise your project in the Project Tree View. +For instance, you are now allowed to add as many root folders as you want, and as many of each kind +as you want. Several users have asked for the ability to add multiple Novel folders, so the old +restriction of only one of each has been removed.

+

You can now also move documents freely between all folders. The Status or Importance values will +switch place depending on the type of root folder your document is in, but the other value should +be preserved if you move the document back. Previously, they were saved as the same value in your +project, so moving them would imply they were overwritten. The new project file format introduced +with this release has no such restriction.

+

Your documents are now also able to have other documents as child items. This is another feature +added based on feedback. You no longer need to make a chapter folder and add chapter files inside +it together with the scene documents. You can add the scene documents directly under the chapter +document and drop the folder entirely. If needed, you can convert an existing folder into a +document at any time. However, you are not allowed to convert a document into a folder.

+

The check mark icon that previously indicated whether a document was included or not in a +manuscript build has been replaced with an active/inactive flag. This was done in preparation for +changes to the Build Novel Project tool which will come in the next release. The active/inactive +flag is now partially just an indicator to you as the writer whether the document is to be +considered a part of your project or not. That said, an inactive setting still causes it to be +excluded from the Novel Tree View and the Novel Outline View.

+

The context (right click) menu for the Project Tree has also been updated. You can make nearly +all changes to the item directly from this menu, with the exception of editing the item label, +which still requires a dialog box.

+

The Split and Merge tools have been rewritten from scratch. You should now have multiple options +on how to structure the resulting document or documents. You can access the new tools from the +"Transform" submenu when right-clicking a project item that supports splitting or merging.

+ +

Novel and Outline View

+

The Novel Tree View and Novel Outline View panels have been given a new design. The heading +level is now shown as an indent with a coloured bar that uses the same colour coding as the +document icons. They are technically no longer tree views, but rather a Table of Contents of a +specific novel root folder. If you have multiple novel root folders, you can select which one to +view.

+

In the Novel Tree View, you now also have the option to hide or show a third column of data. +Currently, you can chose between "Point of View Character", "Focus Character" and "Novel Plot". If +you referenced more than one in the document, the column will only show the first entry, so make +sure the most important one is listed first in your document if you use this feature. An arrow icon +is also visible at the end of each row in the tree, and if you click on it, a tool tip should pop +up showing you all the meta data collected for that specific heading in your text.

+ +

Other Changes

+

There has been a lot of changes under the hood as well, especially in regards to how the project +structure is handled and saved. The project index has also been almost completely rewritten, and +now collects information about your project more efficiently. This improves the way the project +tree determines which document icon to show you, and it also makes the Novel Tree View more +informative as the data there is updated a lot more frequently.

+

The New Project Wizard has been updated with some new features, and simplified a bit. The +Project Settings dialog has been updated to reflect some of the same changes.

See also the Releases page.

diff --git a/sample/nwProject.nwx b/sample/nwProject.nwx index 1945992d..3e2368ad 100644 --- a/sample/nwProject.nwx +++ b/sample/nwProject.nwx @@ -1,6 +1,6 @@ - - + + Sample Project Sample Project Jane Smith