Skip to content

Commit 00b3c3e

Browse files
authored
Release 1.6 Beta 1 (#953)
1 parent 52efbcc commit 00b3c3e

File tree

5 files changed

+107
-120
lines changed

5 files changed

+107
-120
lines changed

CHANGELOG.md

Lines changed: 94 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,96 @@
11
# novelWriter Changelog
22

3+
## Version 1.6 Beta 1 [2022-01-04]
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+
* When text is selected in the editor, the word counter in the editor's footer bar shows the number
18+
of selected words instead of the total document word count. Feature Request #896. PR #899.
19+
* The way page breaks are automatically and manually added has been improved: The Title format no
20+
longer has an automatic page break, Partition and Chapter formats now always have a page break,
21+
Scene and Section headers can now have page breaks added manually, and empty scene header format
22+
will now result in a larger gap between scenes. Feature Request #912. PR #916.
23+
* The Enter, Return and Ctrl+O keyboard shortcuts now open the selected document or item on the
24+
tree that has focus. That is, on the Project Tree, Novel Tree, or in the Outline Tab. Previously,
25+
these key strokes only affected the Project Tree. Feature Request #913. PR #945.
26+
* The search tool in the document editor now shows the number of search results when the search
27+
button is clicked. When the replace tool is used, this number changes if the search result does.
28+
Feature Request #645. PRs #946 and #947.
29+
30+
**Other Changes**
31+
32+
* The icon themes have been merged and reduced to two complete themes, and the Preferences switch
33+
for additional dark icons has been removed. The user either selects the Typicons Dark or Light
34+
theme. No need to match further settings. PR #893.
35+
* Custom GUI themes and syntax themes can now be loaded from the user's data path. The actual
36+
storage path is determined by the OS. Part of Feature Request #892. PR #893.
37+
* A number of text messages and labels on the GUI have been improved. Issue #923. PR #926.
38+
* The switch in Preferences to disbale fixed width text in the editor has been removed. Instead,
39+
the user just sets the fixed with setting to 0 to disable it. The settings is now also applied to
40+
the document viewer as well. Issue #924. PR #943.
41+
* The Open Document export file produced from the build tool is now more LibreOffice and OpenOffice
42+
friendly by using the same default styles as these editors do. Issue #948. PR #949.
43+
* When a document is saved from the document editor, the disk on file is checked for external
44+
changes before it is overwritten. Such changes can arise from editing the file from another tool
45+
at the same time, from file sync issues, or even from file system issues. If an inconsistency is
46+
discovered, the user is asked to confirm the overwrite. Issue #878. PR #890.
47+
48+
**Internationalisation**
49+
50+
* A couple of missing translations, and typos, have been fixed. PRs #921 and #926.
51+
* Latin American Spanish translation has been added by Tommy Marplatt (@tmarplatt). PR #927.
52+
53+
**Bugfixes**
54+
55+
* Fixed an issue where greater or lesser than symbols used in text paragraphs which also has
56+
formatting tags would cause the formatting tags to be shifted in HTML output. Issue #929. PR 928.
57+
This fix was backported to 1.5 as patch 1.5.2. A secondary bug was reported in Issue #950, fixed
58+
in PR #951, and backported to 1.5. as patch 1.5.4.
59+
60+
**Documentation**
61+
62+
* Documentation has been updated to reflect changes and new features. PRs #903, and #916.
63+
* The Readme file for internationalisation has been updated and improved. Contributed by Tommy
64+
Marplatt (@tmarplatt) PR #917.
65+
66+
**Installation and Packaging**
67+
68+
* The Cantarell font is no longer included in the source and releases. PR #893.
69+
* The way icons are loaded is now simpler and there is no longer a bunch of fallback options. The
70+
icon sets have been reduced to just two complete folders of coloured Typicons: one for dark and
71+
one for light backgrounds. PR #893.
72+
* Fixed a couple of issues in the Windows setup scripts where the user never saw the error message
73+
reporting on missing Python as the window would close before the user would be able to read the
74+
error. PR #903.
75+
76+
**Code Improvements**
77+
78+
* Cleaned up log output, formatting, docstrings, and various other code structure and debug related
79+
parts of the source. PRs #904, #926, #930, and #947.
80+
* Optimised various code snippets, either for performance or readability. The code now makes more
81+
use of Python list comprehension and built-in functions for iterables. PRs #904, and #926.
82+
* Tightened up many of the internal classes, making attributes private, and add setter and getter
83+
functions where that makes sense. PRs #904, #931, and #937.
84+
* The tools for adding and updating translation files have been improved. The Qt-specific `.pro`
85+
file has been dropped, and instead the setup tool will scan the entire source tree each time
86+
language files are updated. TS files can also be specified to the command, or if none are
87+
specified, all files are updated. PR #915.
88+
* The language file update command in the setup tool now uses the pylupdate6 tool from PyQt6, which
89+
has been included directly in the `i18n` folder. This tool uses the newer TS file format, which
90+
the standard PyQt5 tool does not. Related to #911. PR #920.
91+
92+
----
93+
394
## Version 1.5.4 [2022-01-04]
495

596
### Release Notes
@@ -204,7 +295,7 @@ _These Release Notes also include the changes from 1.5 Beta 1, Beta 2, and RC 1.
204295
### Release Notes
205296

206297
This is a release candidate of the next release version, and is intended for testing purposes.
207-
Please be careful when using this version on live writing projects, and make sure you make frequent
298+
Please be careful when using this version on live writing projects, and make sure you take frequent
208299
backups.
209300

210301
### Detailed Changelog
@@ -255,7 +346,7 @@ backups.
255346
### Release Notes
256347

257348
This is a beta release of the next release version, and is intended for testing purposes. Please be
258-
careful when using this version on live writing projects, and make sure you make frequent backups.
349+
careful when using this version on live writing projects, and make sure you take frequent backups.
259350

260351
### Detailed Changelog
261352

@@ -292,7 +383,7 @@ careful when using this version on live writing projects, and make sure you make
292383
### Release Notes
293384

294385
This is a beta release of the next release version, and is intended for testing purposes. Please be
295-
careful when using this version on live writing projects, and make sure you make frequent backups.
386+
careful when using this version on live writing projects, and make sure you take frequent backups.
296387

297388
### Detailed Changelog
298389

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
# The short X.Y version
2222
version = "1.6"
2323
# The full version, including alpha/beta/rc tags
24-
release = "1.6-alpha0"
24+
release = "1.6-beta1"
2525

2626
# -- General Configuration ---------------------------------------------------
2727

novelwriter/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@
6060
__author__ = "Veronica Berglyd Olsen"
6161
__maintainer__ = "Veronica Berglyd Olsen"
6262
__email__ = "[email protected]"
63-
__version__ = "1.6-alpha0"
64-
__hexversion__ = "0x010600a0"
65-
__date__ = "2021-09-19"
63+
__version__ = "1.6-beta1"
64+
__hexversion__ = "0x010600b1"
65+
__date__ = "2022-01-04"
6666
__status__ = "Stable"
6767
__domain__ = "novelwriter.io"
6868
__url__ = "https://novelwriter.io"

novelwriter/assets/text/release_notes.htm

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

5-
<h2>Release Notes for 1.5.4</h2>
5+
<h2>Release Notes for 1.6 Beta 1</h2>
66
<p><i>Released on 4 January 2022</i></p>
77

8-
<p>This is a bugfix release that fixes an issues with rendering HTML from a document, either in
9-
the viewer or the build tool, when there is a greater or lesser than symbol in a text block that
10-
isn't a plain text paragraph, like for instance a comment or a heading. Any such document would
11-
fail to render.</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>
1213

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

15-
<hr/>
16-
17-
<h2>Release Notes for 1.5.3</h2>
18-
<p><i>Released on 31 December 2021</i></p>
19-
20-
<p>This is a bugfix release that fixes two cosmetic issues. The first fix resolves and issue with
21-
the emphasis of partition or chapter items in the project tree not changing when the item is
22-
changed to a scene item. The second fix changes how the Create Root Folder submenu works. Instead
23-
of disabling the menu entries that are no longer available, they are instead removed. Disabled menu
24-
entries are not displayed correctly in all colour themes.</p>
25-
26-
<hr/>
27-
28-
<h2>Release Notes for 1.5.2</h2>
29-
<p><i>Released on 12 December 2021</i></p>
30-
31-
<p>This is a bugfix release that fixes two issues. The first is an issue with an error in the HTML
32-
output if a paragraph has alignment or indentation tags while at the same time containing
33-
emphasised text. The second is an issue where the application cannot load a project with spell
34-
checking enabled if there is something wrong with the spell check package.</p>
35-
36-
<hr/>
37-
38-
<h2>Release Notes for 1.5.1</h2>
39-
<p><i>Released on 23 October 2021</i></p>
40-
41-
<p>This is a bugfix release that fixes two issues. One related to the Project Details dialog
42-
missing its translated labels for non-English languages, and a fix concerning switching focus to
43-
the project tree when the Novel tab is visible. If the Novel tab is selected, the focus shift now
44-
correctly gives focus to the Novel tree.</p>
45-
46-
<hr/>
47-
48-
<h2>Release Notes for 1.5</h2>
49-
<p><i>Released on 19 September 2021</i></p>
50-
51-
<p>This release reduces the number of document layouts from eight to two. The full list of changes
52-
is described in the "Novel Document Layouts" section below.</p>
53-
<p>Due to this change, the main project file for your projects will need to be updated when you
54-
first open them in novelWriter 1.5. This is done automatically. The index is updated as well. When
55-
this conversion is done, you can no longer open the project in an older version of novelWriter.</p>
56-
<p>You may also have to make a handful of changes in your novel documents as novelWriter will not
57-
make any automated changes to your actual text. However, the changes are minimal and in any case
58-
only affects the way your manuscript looks like when exported via the Build Novel Project tool.
59-
These details are also described below.</p>
60-
<p>From this release on, Debian packages will be provided for Mint, Ubuntu and Debian users. A new
61-
<a href="https://launchpad.net/~vkbo/+archive/ubuntu/novelwriter">PPA</a> has also been created.
62-
This allows users to install and update novelWriter automatically on these Linux distros.</p>
63-
64-
<h4>Novel Document Layouts</h4>
65-
<p>The main change in this release is the significant simplification of document layouts.
66-
Previously, there were seven different layouts available for novel documents, in addition to the
67-
one layout for project notes. The original intention of these layouts were partially to define some
68-
default formatting behaviour when exporting your project, and partially as a way to indicate
69-
whether a specific document was a partition, chapter or scene.</p>
70-
<p>With this release, all the seven layouts for novel documents have been merged into a single
71-
layout called simply "Novel Document". The other layout, "Project Note", remains unchanged. The
72-
functionality provided by the various novel layouts have been implemented in other ways, and a few
73-
new formatting codes have been added to accommodate the formatting functionality lost with the
74-
removal of the layouts. They are all available in the Format and Insert menus.</p>
75-
<p>The changes you need to make to your project should be limited to altering a handful of titles
76-
and maybe insert a page break code here and there. The only title formats you need to update are
77-
those for the main novel title and for your unnumbered chapters, if you have any.</p>
78-
<p>Novel titles need to be altered from "# Novel Title" to "#! Novel Title" and unnumbered chapters
79-
from "## Chapter Name" or "## *Chapter Name" to "##! Chapter Name". That is all. For inserting page
80-
breaks, you can add a single line with the command "[NEW PAGE]" where you want the break to be
81-
inserted. As before, page breaks are automatically inserted in front of all partition and chapter
82-
titles.</p>
83-
<p>You will find these changes described in more detail in the documentation in the
84-
"<a href="https://novelwriter.readthedocs.io/en/latest/usage_projectformat.html#a-prjfmt-1-3">Format 1.3 Changes</a>"
85-
section.
86-
87-
<h4>GUI Changes</h4>
88-
<p>Due to the above changes, the GUI has been altered a bit. The main changes are in the project
89-
tree. These changes are also reflected in the details panel below the project tree, and to a lesser
90-
extent in the Outline tab.</p>
91-
<p>The layouts were previously a way to indicate the purpose of a specific novel document, like
92-
whether it was a chapter or scene. With these layouts gone, the distinction is instead indicated by
93-
other visual means.</p>
94-
<p>The project index will now record the level of the first header of your document, and select a
95-
different icon for documents with a partition, chapter or scene header. These are colour coded as
96-
green, red, and blue respectively. The project notes have also received a new icon, with a yellow
97-
colour code. Due to this change, the grey icon themes have been removed.</p>
98-
<p>In addition, novel documents with a partition or chapter header will have the document label
99-
viewed as bold and underlined. This feature can be disabled in Preferences if you want a cleaner
100-
look in the project tree.</p>
101-
102-
<h4>Other Changes</h4>
103-
<p>Several improvements have been made to the project index, which means the index will be
104-
automatically rebuilt when you open a project for the first time in the new version. You will get a
105-
notification about this.</p>
106-
<p>The ODT export tool has also been improved. The code that writes out text paragraphs has been
107-
rewritten and now conforms more closely to the Open Document standard. Most of these improvements
108-
will not be noticeable to you as a user, but you may notice that the exported document will now
109-
allow multiple consecutive spaces. Previously, two spaces, or more, would be concatenated into a
110-
single space in the exported document.</p>
111-
<p>The internal spell check tool has been removed. If you want spell checking, you must install the
112-
Spell Enchant tool. The internal spell checker was only ever added because the Python package for
113-
Spell Enchant was not available on 64-bit Windows. This was corrected over a year ago. The main
114-
issue with the internal spell checker was that it only included English, and the large dictionary
115-
files had to be shipped with novelWriter.</p>
116-
<p>Finally, a PDF version of the documentation should now be shipped with your install package. If
117-
it is available, a "User Manual (PDF)" option should be visible in the Help menu. This should give
118-
you access to the documentation also when you don't have an active internet connection.</p>
119-
12016
</body>
12117
</html>

sample/nwProject.nwx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<?xml version='1.0' encoding='utf-8'?>
2-
<novelWriterXML appVersion="1.6-alpha0" hexVersion="0x010600a0" fileVersion="1.3" timeStamp="2021-12-31 14:54:41">
2+
<novelWriterXML appVersion="1.6-beta1" hexVersion="0x010600b1" fileVersion="1.3" timeStamp="2022-01-04 22:43:05">
33
<project>
44
<name>Sample Project</name>
55
<title>Sample Project</title>
66
<author>Jane Smith</author>
77
<author>Jay Doh</author>
8-
<saveCount>1265</saveCount>
8+
<saveCount>1267</saveCount>
99
<autoCount>198</autoCount>
10-
<editTime>62062</editTime>
10+
<editTime>62103</editTime>
1111
</project>
1212
<settings>
1313
<doBackup>False</doBackup>

0 commit comments

Comments
 (0)