Skip to content

Commit 7d0e7d7

Browse files
authored
Release 2.1 Beta 1 (#1490)
2 parents 34c5b4f + 4b2b411 commit 7d0e7d7

File tree

4 files changed

+90
-144
lines changed

4 files changed

+90
-144
lines changed

CHANGELOG.md

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,84 @@
11
# novelWriter Changelog
22

3+
## Version 2.1 Beta 1 [2023-07-30]
4+
5+
### Release Notes
6+
7+
This is a beta release of the next release version, and is intended for testing purposes. Please be
8+
careful when using this version on live writing projects, and make sure you take frequent backups.
9+
10+
Please check the changelog for an overview of changes. The full release notes will be added to the
11+
final release.
12+
13+
### Detailed Changelog
14+
15+
**Usability**
16+
17+
* When the main window is resized, the change in size is only assigned to the editor and viewer. To
18+
resize the project tree area, its slider needs to be moved. PR #1388.
19+
* The default text font on MacOS is now Helvetica instead of Courier. Issue #1463. PR #1479.
20+
* Backup files now contain the project name again. Issue #1476. PR #1484.
21+
* The backup success dialog now displays the file size of the backup file. Issue #1453. PR #1484.
22+
* New root folders in the Project Tree now appear next to the root folder of the item selected when
23+
the request to make the root folder was made. Previously, it would appear at the bottom of the
24+
Project Tree. Issue #1259. PR #1487.
25+
26+
**Features**
27+
28+
* A new Manuscript Build Tool has been added. The new tool allows for detailed handling of which
29+
documents are included in a build, as well as a much better tool for formatting headers. It also
30+
allows for saving multiple build presets. PRs #1389 and #1466. Issues #971, #1315 and #1448.
31+
* Exported ODT documents now have an accessible style for scene separators. It is also possible to
32+
define page size and margin sizes from the new build tool. Issue #622. PR #1477.
33+
* A proper light colour theme has been added. The default theme will usually default to light
34+
colours, but in Qt6 it will not depending on host OS settings, so creating a proper light theme
35+
is needed. This also allows for some tweaking of the colours. The contrast of the dark theme has
36+
been improved a bit as well, and a default icon theme is now selected based on the lightness of
37+
the background if an icon theme is not specified in the theme definition file.
38+
Issues #1472 and #1473. PR #1475.
39+
* Documents, folders and root folders can now be duplicated from the Project Tree, including all
40+
child elements. The duplicated content is stored next to the source items, and can then be moved
41+
to wherever the user wants a copy. Issue #1469. PR #1480.
42+
* A set of new keyboard shortcuts have been added to make some types of navigation in the Project
43+
Tree easier. `Alt+Up` and `Alt+Down` will move between sibling items in the tree, skipping child
44+
items. `Alt+Left` will move to the parent of the selected item without triggering the collapse of
45+
the node like the `Left` key does. `Alt+Right` does the reverse, and both expands the node and
46+
moves to the first child in one click. Issue #1348. PRs #1488 and #1489.
47+
48+
**Packaging and Installation**
49+
50+
* Support for Python 3.7 is no longer maintained, but has not officially been dropped. It is
51+
expected to be dropped for the final release of 2.1. PR #1452.
52+
* The `lxml` package has been removed from the source code, dropping it as a dependency of
53+
novelWriter. The standard Python `xml` library is used instead. The standard library is somewhat
54+
limited, which is why it wasn't originally used, but when dropping support for Python 3.7, it is
55+
now good alternative. Issue #1257. PR #1452.
56+
* The `setup.py` file has been removed. The custom packaging utilities in the old `setup.py` file
57+
are now available in `pkgutils.py` instead. Issues #1437 and #1438. PR #1483.
58+
59+
**Code Improvements**
60+
61+
* All imports of modules are now direct imports instead of going via init files. All subfolder init
62+
files have been reduced to empty files. PR #1262.
63+
* The mocking of the main config object in the test suite has been rewritten to be easier to deal
64+
with when writing tests. The new approach also removes the need to access the config object via
65+
an attribute in many classes, and is now instead accessed directly. This should give a tiny
66+
performance boost as a bonus. PR #1447.
67+
* The building of manuscript documents from novelWriter source text is now handled by a core
68+
builder class, thus separating it from any GUI module. Previously, this was baked into the build
69+
tool. PR #1316.
70+
* SVG icons have been optimised in terms of storage size and object complexity. PR #1456.
71+
* The file names for the project meta data files have been simplified and references to legacy
72+
formats removed. The wordlist has been converted to a JSON file, and the session log to a JSON
73+
Lines file. All old files are renamed or converted on the fly when opening the project. PR #1464.
74+
* The core project item and tree classes have been modified to improve how items, and in
75+
particular, orphaned items are handled. These are mostly internal changes that simplifies how
76+
items are accessed in the source code. Issue #1481. PR #1482.
77+
* Many of the above PRs adds type annotations to classes and functions in the source code. These
78+
will be added gradually to the entire source code going forward.
79+
80+
----
81+
382
## Version 2.0.7 [2023-04-16]
483

584
### Release Notes
@@ -208,7 +287,7 @@ dialog box, replacing the Credits section on the main About tab.
208287
* Update Chinese translation. PR #1298.
209288
* Update Norwegian, US English, German and Spanish translations. PR #1311.
210289

211-
**Other CHanges**
290+
**Other Changes**
212291

213292
* An icon theme can now be loaded from the user's data folder alongside a custom user theme.
214293
Issue #1297. PR #1299.

novelwriter/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
__email__ = "[email protected]"
6161
__version__ = "2.1-beta1"
6262
__hexversion__ = "0x020100b1"
63-
__date__ = "2023-06-19"
63+
__date__ = "2023-07-30"
6464
__status__ = "Stable"
6565
__domain__ = "novelwriter.io"
6666

novelwriter/assets/text/release_notes.htm

Lines changed: 7 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -2,149 +2,16 @@
22
<html>
33
<body>
44

5-
<h2>Release Notes for 2.0</h2>
6-
<p><i>Released on 28 November 2022</i></p>
5+
<h2>Release Notes for 2.1 Beta 1</h2>
6+
<p><i>Released on 30 July 2023</i></p>
77

8-
<p>Scroll down for <a href="#patch">Patch Notes</a></p>
9-
10-
<p>This release includes a major update to the way your project is managed. It also modernises the
11-
user interface. The project file format has also been updated, and your projects will be upgraded
12-
the first time you open them in this release.</p>
13-
<p>There are some major changes under the hood in this release. A lot of the code has been
14-
rewritten and split up into smaller components. A lot of this is to make it more efficient, but
15-
also to make it more modular in preparation for planned future additions. Most of these changes
16-
don't affect you as the user, but there are also a number of big feature changes that you will
17-
notice.</p>
18-
19-
<h3>User Interface Changes</h3>
20-
<p>The tabs used to switch between the Project Tree and Novel Tree, as well as between the Editor
21-
and Outline views, have been replaced with a side bar. The side bar is located on the left side of
22-
the main window, and gives you the option to select between "Project Tree View", "Novel Tree View"
23-
and "Outline Tree View". They correspond to the previous tabs.</p>
24-
<p>The side bar also includes a shortcut to the "Build Novel Project" tool. The "Project Details",
25-
"Writing Statistics" and "Settings" buttons that were previously below the project tree are now
26-
located at the bottom of the side bar.</p>
27-
<p>All three views have also been given updates. They each have a label and a toolbar. The Project
28-
Tree View has a dropdown with quick links to all your root folders, which should make it easier to
29-
navigate a large project tree. You can activate the link menu by pressing `Ctrl+L` while in the
30-
Project Tree, so you don't need to move your mouse.</p>
31-
<p>A dropdown menu with all the options for adding new items to your project has also been added to
32-
this toolbar. This too can be activated directly with a shortcut, `Ctrl+N`. More options are
33-
available under the menu button, and there are also a set of move up and down buttons for moving
34-
items.</p>
35-
<p>The Novel Tree View and Novel Outline View have also received toolbars and controls that let you
36-
select which data to show, and customise the view.</p>
37-
38-
<h3>Changes to Project Structure</h3>
39-
<p>A number of changes have been made to how you organise your project in the Project Tree View.
40-
For instance, you are now allowed to add as many root folders as you want, and as many of each kind
41-
as you want. Several users have asked for the ability to add multiple Novel folders, so the old
42-
restriction of only one of each has been removed.</p>
43-
<p>You can now also move documents freely between all folders. The Status or Importance values will
44-
switch place depending on the type of root folder your document is in, but the other value should
45-
be preserved if you move the document back. Previously, they were saved as the same value in your
46-
project, so moving them would imply they were overwritten. The new project file format introduced
47-
with this release has no such restriction.</p>
48-
<p>Your documents are now also able to have other documents as child items. This is another feature
49-
added based on feedback. You no longer need to make a chapter folder and add chapter files inside
50-
it together with the scene documents. You can add the scene documents directly under the chapter
51-
document and drop the folder entirely. If needed, you can convert an existing folder into a
52-
document at any time. However, you are not allowed to convert a document into a folder.</p>
53-
<p>The check mark icon that previously indicated whether a document was included or not in a
54-
manuscript build has been replaced with an active/inactive flag. This was done in preparation for
55-
changes to the Build Novel Project tool which will come in the next release. The active/inactive
56-
flag is now primarily just an indicator to you as the writer whether the document is to be
57-
considered a part of your project or not. That said, an inactive setting still causes it to be
58-
excluded from the Novel Tree View and the Novel Outline View.</p>
59-
<p>The context (right click) menu for the Project Tree has also been updated. You can make nearly
60-
all changes to the item directly from this menu, with the exception of editing the item label,
61-
which still requires a dialog box.</p>
62-
<p>The Split and Merge tools have been rewritten from scratch. You should now have multiple options
63-
on how to structure the resulting document or documents. You can access the new tools from the
64-
"Transform" submenu when right-clicking a project item that supports splitting or merging.</p>
65-
66-
<h3>Novel and Outline View</h3>
67-
<p>The Novel Tree View and Novel Outline View panels have been given a new design. The heading
68-
level is now shown as an indent with a coloured bar that uses the same colour coding as the
69-
document icons. They are technically no longer tree views, but rather a Table of Contents of a
70-
specific novel root folder. If you have multiple novel root folders, you can select which one to
71-
view.</p>
72-
<p>In the Novel Tree View, you now also have the option to hide or show a third column of data.
73-
Currently, you can choose between "Point of View Character", "Focus Character" and "Novel Plot". If
74-
you referenced more than one in the document, the column will only show the first entry, so make
75-
sure the most important one is listed first in your document if you use this feature. An arrow icon
76-
is also visible at the end of each row in the tree, and if you click on it, a tool tip should pop
77-
up showing you all the meta data collected for that specific heading in your text.</p>
78-
79-
<h3>Other Changes</h3>
80-
<p>There has been a lot of changes under the hood as well, especially in regards to how the project
81-
structure is handled and saved. The project index has also been almost completely rewritten, and
82-
now collects information about your project more efficiently. This improves the way the project
83-
tree determines which document icon to show you, and it also makes the Novel Tree View more
84-
informative as the data there is updated a lot more frequently.</p>
85-
<p>The New Project Wizard has been updated with some new features, and simplified a bit. The
86-
Project Settings dialog has been updated to reflect some of the same changes.</p>
8+
<p>This is a beta release of the next release version, and is intended for testing purposes. Please
9+
be careful when using this version on live writing projects, and make sure you take frequent
10+
backups.</p>
11+
<p>Please check the changelog for an overview of changes. The full release notes will be added to
12+
the final release.</p>
8713

8814
<p><i>See also the <a href="https://github.com/vkbo/novelWriter/releases">Releases</a> page.</i></p>
8915

90-
<a name="patch"></a><h2>Patch Notes</h2>
91-
92-
<h3>Patch 2.0.1 &ndash; 29 November 2022</h3>
93-
94-
<p>This is a patch release that fixes a minor issues with loading custom GUI themes that haven't
95-
been updated to include the icon theme setting. The patch also updates the French translation.</p>
96-
97-
<h3>Patch 2.0.2 &ndash; 1 December 2022</h3>
98-
99-
<p>This is a patch release that fixes a minor issues with syntax highlighting not updating when the
100-
highlighting preferences were changed. It also fixes an issue that broke the FreeBSD release.</p>
101-
102-
<h3>Patch 2.0.3 &ndash; 8 January 2023</h3>
103-
104-
<p>This is a patch release that fixes a few bugs and usability issues. The editing of status and
105-
importance labels in Project Settings should now be a bit more intuitive. Opening a document from
106-
the Outline View that is already open in the editor should now switch to the editor view. The
107-
convert folder to note or document feature in the project tree has also been fixed. Some icons have
108-
been updated and a renderring issue with one of them fixed. Chinese, Norwegian, US English, German
109-
and Spanish translations have been updated as well. A new credits tab has been added to the About
110-
dialog box, replacing the Credits section on the main About tab.</p>
111-
112-
<h3>Patch 2.0.4 &ndash; 29 January 2023</h3>
113-
114-
<p>This is a patch release that fixes a bug where novelWriter would crash if PyQt5 version 5.15.8
115-
was installed and imported.</p>
116-
117-
<h3>Patch 2.0.5 &ndash; 12 February 2023</h3>
118-
119-
<p>This is a patch release that fixes a number of minor bugs and usability issues.</p>
120-
<p>The Project Details dialog now properly updates when another project is opened, and the "Total
121-
editing time" value has a less ambiguous time format. The editor no longer inserts blank lines if
122-
block formats are applied to an empty line. The optional last column in the Novel Tree will now
123-
show all items of the selected type, not only the first, and the column size can be adjusted from
124-
the same menu where the column content is selected. The Open Document build output has been updated
125-
to ODF 1.3 extended format, and passes validation.</p>
126-
<p>An Italian translation has been added, and Russian is currently available for project builds. A
127-
full translation into Russian is on its way.</p>
128-
129-
<h3>Patch 2.0.6 &ndash; 26 February 2023</h3>
130-
131-
<p>This is a patch release that fixes a few minor bugs and a broken feature.</p>
132-
<p>When opening a document from the Novel Tree or Outline View, the Project Tree would receive
133-
focus even when it was hidden. This has been corrected and no focus change is made. The Project
134-
Tree now also receives focus automatically when a new Project Item is created.</p>
135-
<p>The backlinks in the Reference Panel below the Document Viewer were no longer working. They have
136-
now been fixed. They were broken due to a change in the link format in 2.0.</p>
137-
138-
<h3>Patch 2.0.7 &ndash; 16 April 2023</h3>
139-
140-
<p>This is a patch release that fixes a few issues and adds a Japanese translation.</p>
141-
<p>The issues were mostly related to spell checking. In particular, issues with finding the word
142-
boundary when using underscore characters for italics markup. These issues should now be resolved.
143-
In addition, escaped markup characters are now renderred properly in HTML and ODT build formats.</p>
144-
<p>A few usability improvements have also been made. The Add Item menu in the project tree no
145-
longer shows the options to create Novel Documents when an item in the tree is selected that cannot
146-
hold such a document. In addition, the "Change Label" context menu entry has been changed to say
147-
"Rename", which is a more logical choice.</p>
148-
14916
</body>
15017
</html>

sample/nwProject.nwx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version='1.0' encoding='utf-8'?>
2-
<novelWriterXML appVersion="2.0.7" hexVersion="0x020007f0" fileVersion="1.5" fileRevision="1" timeStamp="2023-07-19 18:03:08">
3-
<project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="1513" autoCount="237" editTime="75226">
2+
<novelWriterXML appVersion="2.1-beta1" hexVersion="0x020100b1" fileVersion="1.5" fileRevision="1" timeStamp="2023-07-30 14:08:40">
3+
<project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="1514" autoCount="237" editTime="75228">
44
<name>Sample Project</name>
55
<title>Sample Project</title>
66
<author>Jane Smith</author>

0 commit comments

Comments
 (0)