Skip to content

Commit 6c9c1ec

Browse files
authored
Release 2.2 Beta 1 (#1595)
2 parents 9e4ac8f + 88ba3b3 commit 6c9c1ec

File tree

4 files changed

+94
-65
lines changed

4 files changed

+94
-65
lines changed

CHANGELOG.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,82 @@
11
# novelWriter Changelog
22

3+
## Version 2.2 Beta 1 [2023-11-11]
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+
**Features**
16+
17+
* novelWriter has a new logo and icon. PR #1593.
18+
* The Document Editor is now a true plain text editor. This has a number of benefits and a couple
19+
of drawbacks. The most important benefits is that the editor responds a lot faster, and can hold
20+
much larger text documents. The big document limit has therefore been removed. It mostly affected
21+
automatic spell checking. The syntax highlighter and spell checker are also more efficient, which
22+
allows for needed improvements to these. The drawbacks are mainly that the editor now scrolls one
23+
line at a time, instead of scrolling pixel by pixel like before. PRs #1521 and #1525.
24+
* Tags and References are now case insensitive. Their display name on the user interface remains
25+
the same as the value set for the `@tag` entry. Issue #1313. PRs #1522 and #1578.
26+
* Keywords for Tags and References, and the References themselves, now have an auto-complete menu
27+
that pops up in the editor on lines starting with the `@` character. It will first suggest what
28+
keyword you want to use, and when it has been added, use that keyword to look up suggestions for
29+
references to add. The suggestions improve as you type by looking for the characters you've
30+
already typed in the tags you've previously defined. Issue #823. PR #1581.
31+
* You can now right-click an undefined tag, and a context menu option to create a Project Note for
32+
that tag will appear in the menu. On selection, it will create a note in the first root folder of
33+
the correct kind, and set the title and tag to match the undefined reference, making it instantly
34+
defined. Issues #1580 and #823. PR #1582.
35+
* Shortcodes have been added to the Document Editor. Shorcodes are HTML-like syntax, but uses
36+
square brackets instead of angular brackets. So `[b]text[/b]` will make the word "text" appear as
37+
bold. Shortcodes currently support bold, italic, striketrough, underline, superscript and
38+
subscript text. The first three are complimentary to the Markdown-like syntax that. The benefit
39+
of the shortcode emphasis syntax, however, is that it does not care about word boundaries, and
40+
can therefore be used any place in the text. Including in the middle of words. Issues #1337 and
41+
#1444. PRs #1540 and #1583.
42+
* A show/hide toolbar has been added to the editor where toolbuttons for formatting options are
43+
available. The toolbar is hidden by default, but can be activated from a three dots icon in the
44+
top left corner of the editor. Issue #1585. PR #1584.
45+
* Build Definitions in the Manuscript Build tool can now be re-ordered, and the order is preserved
46+
when the tool is closed and re-opened. Issue #1542. PR #1591.
47+
48+
**Usability**
49+
50+
* The Settings menu in the sidebar now always pops out to the right and upwards from the bottom of
51+
the icon. The previous behaviour was not guaranteed to stay in the vissible area of the screen.
52+
PR #1520.
53+
* The right click action on a misspelled word now uses the actual spell checker data for lookup.
54+
Previously, the spell checker would underline a word that was misspelled, but the right click
55+
action actually had no way of reading where the error line was, so it had to guess again what
56+
word the user was clicking. Since these two parts of the code used different logic, they
57+
sometimes produced different results. The spell checker now saves the location of each spell
58+
check error, and the right click action retrieves this data when genrating suggestions, which
59+
should eliminate the problem of picking the correct word boundaries. Issue #1532. PR #1525.
60+
* The language of a project is not set in the New Project Wizard and in Project Settings. It is no
61+
longer defined in the Build Settings panel. Issue #1588. PR #1589.
62+
* The way switching focus and view in the main GUi has changed. Pressing `Ctrl+T` will now switch
63+
focus to the Project or Novel Tree if focus is elsewhere, or if either have focus already, it
64+
will switch view to the other tree. Pressing `Ctrl+E` will switch focus and view to the Document
65+
Editor. Pressing `Ctrl+Shift+T` will do the same for the Outline View. The old Alt-based shorcuts
66+
have been removed. Issues #1310 and #1291. PR #1590.
67+
68+
**User Interface**
69+
70+
* The labels under the sidebar buttons have been removed. The tooltips have the necessary
71+
information. PR #1520.
72+
73+
**Other Improvements**
74+
75+
* Also the Tags and References keywords are now translated into the project language when these are
76+
included in Manuscript builds. As long as the phrases have been translated. PR #1586.
77+
78+
----
79+
380
## Version 2.1.1 [2023-11-05]
481

582
### Release Notes

novelwriter/__init__.py

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -33,36 +33,18 @@
3333
from novelwriter.config import Config
3434
from novelwriter.shared import SharedData
3535

36-
##
37-
# Version Scheme
38-
# ================
39-
# Generally follows PEP 440
40-
# Hex Version:
41-
# - Digit 1,2 : Major Version (01-ff)
42-
# - Digit 3,4 : Minor Version (01-ff)
43-
# - Digit 5,6 : Patch Version (01-ff)
44-
# - Digit 7 : Release Type (a: alpha, b: beta, c: candidate, f: final)
45-
# - Digit 8 : Release Number (0-f)
46-
#
47-
# Example : Full Short Description
48-
# --------------------------------------------------------------------
49-
# 0x010200a0 : 1.2-alpha0 1.2a0 Use while developing next release
50-
# 0x010200a1 : 1.2-alpha1 1.2a1 First alpha release
51-
# 0x010200b1 : 1.2-beta1 1.2b1 First beta release
52-
# 0x010200c1 : 1.2-rc1 1.2rc1 First release candidate
53-
# 0x010200f0 : 1.2.0 1.2.0 Final release
54-
# 0x010201f0 : 1.2.1 1.2.1 Patch release
55-
##
36+
# Package Meta
37+
# ============
5638

5739
__package__ = "novelwriter"
5840
__copyright__ = "Copyright 2018–2023, Veronica Berglyd Olsen"
5941
__license__ = "GPLv3"
6042
__author__ = "Veronica Berglyd Olsen"
6143
__maintainer__ = "Veronica Berglyd Olsen"
6244
__email__ = "[email protected]"
63-
__version__ = "2.2-alpha1"
64-
__hexversion__ = "0x020200a1"
65-
__date__ = "2023-09-01"
45+
__version__ = "2.2-beta1"
46+
__hexversion__ = "0x020200b1"
47+
__date__ = "2023-11-12"
6648
__status__ = "Stable"
6749
__domain__ = "novelwriter.io"
6850

novelwriter/assets/text/release_notes.htm

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

5-
<h2>Release Notes for 2.1</h2>
6-
<p><i>Released on 17 October 2023</i></p>
5+
<h2>Release Notes for 2.2 Beta 1</h2>
6+
<p><i>Released on 11 November 2023</i></p>
77

8-
<p>Scroll down for <a href="#patch">Patch Notes</a></p>
9-
10-
<p>The primary focus of this release has been a complete redesign of the Build Tool, that is, the
11-
tool that assembles your project into a manuscript document. The new tool, called the "Manuscript
12-
Build Tool" allows you to define multiple build definitions for your project. The build definitions
13-
are edited in a new Manuscript Build Settings dialog, with a lot more options than the old tool.</p>
14-
<p>The reason for this redesign is a long list of feature requests that could not easily be
15-
accommodated in the old, much simpler tool. Far from all the features have been added yet, but now
16-
that the new tool is in place, they will be gradually added in the coming releases.</p>
17-
<p>The key feature added in this release is the extended control you now have for selecting exactly
18-
what part of your project is included in a given build definition. You have the same filters for
19-
selecting documents and notes, and turning on or off root folders as before, but you can now easily
20-
override on a per-document basis what is included or excluded in addition to the filter.</p>
21-
<p>A second major improvement is a better tool to format your manuscript headings. You no longer
22-
have to look up formatting codes and add them manually. Instead, there is now a heading format
23-
editor in the Build Settings dialog for creating the header format, with syntax highlighting
24-
included.</p>
25-
26-
<h3>Other Changes</h3>
27-
<p>Among other features is a new option to duplicate documents and folders in the project tree. The
28-
duplicate feature is available from the right-click menu. A proper light colour theme has also been
29-
added. In most cases it will be the same as the default theme, depending on your platform.</p>
30-
<p>There are other, minor improvements as well, and a lot of code improvements under the hood. For
31-
a full list of changes, see the detailed changelogs.</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>
3213

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

35-
<a name="patch"></a><h2>Patch Notes</h2>
36-
37-
<h3>Patch 2.2.1 &ndash; 5 November 2023</h3>
38-
39-
<p>This is a patch release that fixes a layout issue and internationalisation issues with the new
40-
Manuscript Build tool. It also fixes a number of issues related to bugs in the underlying Qt
41-
framework that affects drag and drop functionality in the project tree. These issues were mostly
42-
only affecting Debian Linux package releases.</p>
43-
<p>Other, minor issues related to updating the editor on colour theme change and project word list
44-
changes have been fixed as well. See the full changelog for more details.</p>
45-
4616
</body>
4717
</html>

sample/nwProject.nwx

Lines changed: 5 additions & 5 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.2-alpha1" hexVersion="0x020200a1" fileVersion="1.5" fileRevision="1" timeStamp="2023-11-06 11:44:21">
3-
<project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="1609" autoCount="255" editTime="81165">
2+
<novelWriterXML appVersion="2.2-beta1" hexVersion="0x020200b1" fileVersion="1.5" fileRevision="1" timeStamp="2023-11-11 22:48:30">
3+
<project id="e2be99af-f9bf-4403-857a-c3d1ac25abea" saveCount="1611" autoCount="255" editTime="81193">
44
<name>Sample Project</name>
55
<title>Sample Project</title>
66
<author>Jane Smith</author>
@@ -36,7 +36,7 @@
3636
<entry key="i56be10" count="1" red="117" green="0" blue="175">Main</entry>
3737
</importance>
3838
</settings>
39-
<content items="27" novelWords="989" notesWords="409">
39+
<content items="27" novelWords="987" notesWords="409">
4040
<item handle="7031beac91f75" parent="None" root="7031beac91f75" order="0" type="ROOT" class="NOVEL">
4141
<meta expanded="yes" />
4242
<name status="sc24b8f" import="ia857f0">Novel</name>
@@ -46,7 +46,7 @@
4646
<name status="sc24b8f" import="ia857f0" active="yes">Title Page</name>
4747
</item>
4848
<item handle="974e400180a99" parent="7031beac91f75" root="7031beac91f75" order="1" type="FILE" class="NOVEL" layout="DOCUMENT">
49-
<meta expanded="no" heading="H0" charCount="269" wordCount="51" paraCount="3" cursorPos="275" />
49+
<meta expanded="no" heading="H0" charCount="250" wordCount="49" paraCount="2" cursorPos="275" />
5050
<name status="sf12341" import="ia857f0" active="yes">Page</name>
5151
</item>
5252
<item handle="edca4be2fcaf8" parent="7031beac91f75" root="7031beac91f75" order="2" type="FILE" class="NOVEL" layout="DOCUMENT">
@@ -58,7 +58,7 @@
5858
<name status="sf24ce6" import="ia857f0" active="yes">Chapter One</name>
5959
</item>
6060
<item handle="636b6aa9b697b" parent="6a2d6d5f4f401" root="7031beac91f75" order="0" type="FILE" class="NOVEL" layout="DOCUMENT">
61-
<meta expanded="no" heading="H3" charCount="2901" wordCount="513" paraCount="15" cursorPos="749" />
61+
<meta expanded="no" heading="H3" charCount="2901" wordCount="513" paraCount="15" cursorPos="48" />
6262
<name status="s90e6c9" import="ia857f0" active="yes">Making a Scene</name>
6363
</item>
6464
<item handle="bc0cbd2a407f3" parent="6a2d6d5f4f401" root="7031beac91f75" order="1" type="FILE" class="NOVEL" layout="DOCUMENT">

0 commit comments

Comments
 (0)