diff --git a/CHANGELOG.md b/CHANGELOG.md index ebfd568e..d6070f53 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,96 @@ # novelWriter Changelog +## Version 1.6 Beta 1 [2022-01-04] + +### Release Notes + +This is a beta release 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. + +### Detailed Changelog + +**Features** + +* When text is selected in the editor, the word counter in the editor's footer bar shows the number + of selected words instead of the total document word count. Feature Request #896. PR #899. +* The way page breaks are automatically and manually added has been improved: The Title format no + longer has an automatic page break, Partition and Chapter formats now always have a page break, + Scene and Section headers can now have page breaks added manually, and empty scene header format + will now result in a larger gap between scenes. Feature Request #912. PR #916. +* The Enter, Return and Ctrl+O keyboard shortcuts now open the selected document or item on the + tree that has focus. That is, on the Project Tree, Novel Tree, or in the Outline Tab. Previously, + these key strokes only affected the Project Tree. Feature Request #913. PR #945. +* The search tool in the document editor now shows the number of search results when the search + button is clicked. When the replace tool is used, this number changes if the search result does. + Feature Request #645. PRs #946 and #947. + +**Other Changes** + +* The icon themes have been merged and reduced to two complete themes, and the Preferences switch + for additional dark icons has been removed. The user either selects the Typicons Dark or Light + theme. No need to match further settings. PR #893. +* Custom GUI themes and syntax themes can now be loaded from the user's data path. The actual + storage path is determined by the OS. Part of Feature Request #892. PR #893. +* A number of text messages and labels on the GUI have been improved. Issue #923. PR #926. +* The switch in Preferences to disbale fixed width text in the editor has been removed. Instead, + the user just sets the fixed with setting to 0 to disable it. The settings is now also applied to + the document viewer as well. Issue #924. PR #943. +* The Open Document export file produced from the build tool is now more LibreOffice and OpenOffice + friendly by using the same default styles as these editors do. Issue #948. PR #949. +* When a document is saved from the document editor, the disk on file is checked for external + changes before it is overwritten. Such changes can arise from editing the file from another tool + at the same time, from file sync issues, or even from file system issues. If an inconsistency is + discovered, the user is asked to confirm the overwrite. Issue #878. PR #890. + +**Internationalisation** + +* A couple of missing translations, and typos, have been fixed. PRs #921 and #926. +* Latin American Spanish translation has been added by Tommy Marplatt (@tmarplatt). PR #927. + +**Bugfixes** + +* Fixed an issue where greater or lesser than symbols used in text paragraphs which also has + formatting tags would cause the formatting tags to be shifted in HTML output. Issue #929. PR 928. + This fix was backported to 1.5 as patch 1.5.2. A secondary bug was reported in Issue #950, fixed + in PR #951, and backported to 1.5. as patch 1.5.4. + +**Documentation** + +* Documentation has been updated to reflect changes and new features. PRs #903, and #916. +* The Readme file for internationalisation has been updated and improved. Contributed by Tommy + Marplatt (@tmarplatt) PR #917. + +**Installation and Packaging** + +* The Cantarell font is no longer included in the source and releases. PR #893. +* The way icons are loaded is now simpler and there is no longer a bunch of fallback options. The + icon sets have been reduced to just two complete folders of coloured Typicons: one for dark and + one for light backgrounds. PR #893. +* Fixed a couple of issues in the Windows setup scripts where the user never saw the error message + reporting on missing Python as the window would close before the user would be able to read the + error. PR #903. + +**Code Improvements** + +* Cleaned up log output, formatting, docstrings, and various other code structure and debug related + parts of the source. PRs #904, #926, #930, and #947. +* Optimised various code snippets, either for performance or readability. The code now makes more + use of Python list comprehension and built-in functions for iterables. PRs #904, and #926. +* Tightened up many of the internal classes, making attributes private, and add setter and getter + functions where that makes sense. PRs #904, #931, and #937. +* The tools for adding and updating translation files have been improved. The Qt-specific `.pro` + file has been dropped, and instead the setup tool will scan the entire source tree each time + language files are updated. TS files can also be specified to the command, or if none are + specified, all files are updated. PR #915. +* The language file update command in the setup tool now uses the pylupdate6 tool from PyQt6, which + has been included directly in the `i18n` folder. This tool uses the newer TS file format, which + the standard PyQt5 tool does not. Related to #911. PR #920. + +---- + ## Version 1.5.4 [2022-01-04] ### Release Notes @@ -204,7 +295,7 @@ _These Release Notes also include the changes from 1.5 Beta 1, Beta 2, and RC 1. ### Release Notes 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 make frequent +Please be careful when using this version on live writing projects, and make sure you take frequent backups. ### Detailed Changelog @@ -255,7 +346,7 @@ backups. ### Release Notes This is a beta release 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 make frequent backups. +careful when using this version on live writing projects, and make sure you take frequent backups. ### Detailed Changelog @@ -292,7 +383,7 @@ careful when using this version on live writing projects, and make sure you make ### Release Notes This is a beta release 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 make frequent backups. +careful when using this version on live writing projects, and make sure you take frequent backups. ### Detailed Changelog diff --git a/docs/source/conf.py b/docs/source/conf.py index 20cb6425..0c2f6aec 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -21,7 +21,7 @@ author = "Veronica Berglyd Olsen" # The short X.Y version version = "1.6" # The full version, including alpha/beta/rc tags -release = "1.6-alpha0" +release = "1.6-beta1" # -- General Configuration --------------------------------------------------- diff --git a/novelwriter/__init__.py b/novelwriter/__init__.py index 8d31499d..7e3b3ba0 100644 --- a/novelwriter/__init__.py +++ b/novelwriter/__init__.py @@ -60,9 +60,9 @@ __license__ = "GPLv3" __author__ = "Veronica Berglyd Olsen" __maintainer__ = "Veronica Berglyd Olsen" __email__ = "code@vkbo.net" -__version__ = "1.6-alpha0" -__hexversion__ = "0x010600a0" -__date__ = "2021-09-19" +__version__ = "1.6-beta1" +__hexversion__ = "0x010600b1" +__date__ = "2022-01-04" __status__ = "Stable" __domain__ = "novelwriter.io" __url__ = "https://novelwriter.io" diff --git a/novelwriter/assets/text/release_notes.htm b/novelwriter/assets/text/release_notes.htm index 15fc6ee2..0a2d6eed 100644 --- a/novelwriter/assets/text/release_notes.htm +++ b/novelwriter/assets/text/release_notes.htm @@ -2,120 +2,16 @@ -

Release Notes for 1.5.4

+

Release Notes for 1.6 Beta 1

Released on 4 January 2022

-

This is a bugfix release that fixes an issues with rendering HTML from a document, either in -the viewer or the build tool, when there is a greater or lesser than symbol in a text block that -isn't a plain text paragraph, like for instance a comment or a heading. Any such document would -fail to render.

+

This is a beta release 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.

See also the Releases page.

-
- -

Release Notes for 1.5.3

-

Released on 31 December 2021

- -

This is a bugfix release that fixes two cosmetic issues. The first fix resolves and issue with -the emphasis of partition or chapter items in the project tree not changing when the item is -changed to a scene item. The second fix changes how the Create Root Folder submenu works. Instead -of disabling the menu entries that are no longer available, they are instead removed. Disabled menu -entries are not displayed correctly in all colour themes.

- -
- -

Release Notes for 1.5.2

-

Released on 12 December 2021

- -

This is a bugfix release that fixes two issues. The first is an issue with an error in the HTML -output if a paragraph has alignment or indentation tags while at the same time containing -emphasised text. The second is an issue where the application cannot load a project with spell -checking enabled if there is something wrong with the spell check package.

- -
- -

Release Notes for 1.5.1

-

Released on 23 October 2021

- -

This is a bugfix release that fixes two issues. One related to the Project Details dialog -missing its translated labels for non-English languages, and a fix concerning switching focus to -the project tree when the Novel tab is visible. If the Novel tab is selected, the focus shift now -correctly gives focus to the Novel tree.

- -
- -

Release Notes for 1.5

-

Released on 19 September 2021

- -

This release reduces the number of document layouts from eight to two. The full list of changes -is described in the "Novel Document Layouts" section below.

-

Due to this change, the main project file for your projects will need to be updated when you -first open them in novelWriter 1.5. This is done automatically. The index is updated as well. When -this conversion is done, you can no longer open the project in an older version of novelWriter.

-

You may also have to make a handful of changes in your novel documents as novelWriter will not -make any automated changes to your actual text. However, the changes are minimal and in any case -only affects the way your manuscript looks like when exported via the Build Novel Project tool. -These details are also described below.

-

From this release on, Debian packages will be provided for Mint, Ubuntu and Debian users. A new -PPA has also been created. -This allows users to install and update novelWriter automatically on these Linux distros.

- -

Novel Document Layouts

-

The main change in this release is the significant simplification of document layouts. -Previously, there were seven different layouts available for novel documents, in addition to the -one layout for project notes. The original intention of these layouts were partially to define some -default formatting behaviour when exporting your project, and partially as a way to indicate -whether a specific document was a partition, chapter or scene.

-

With this release, all the seven layouts for novel documents have been merged into a single -layout called simply "Novel Document". The other layout, "Project Note", remains unchanged. The -functionality provided by the various novel layouts have been implemented in other ways, and a few -new formatting codes have been added to accommodate the formatting functionality lost with the -removal of the layouts. They are all available in the Format and Insert menus.

-

The changes you need to make to your project should be limited to altering a handful of titles -and maybe insert a page break code here and there. The only title formats you need to update are -those for the main novel title and for your unnumbered chapters, if you have any.

-

Novel titles need to be altered from "# Novel Title" to "#! Novel Title" and unnumbered chapters -from "## Chapter Name" or "## *Chapter Name" to "##! Chapter Name". That is all. For inserting page -breaks, you can add a single line with the command "[NEW PAGE]" where you want the break to be -inserted. As before, page breaks are automatically inserted in front of all partition and chapter -titles.

-

You will find these changes described in more detail in the documentation in the -"Format 1.3 Changes" -section. - -

GUI Changes

-

Due to the above changes, the GUI has been altered a bit. The main changes are in the project -tree. These changes are also reflected in the details panel below the project tree, and to a lesser -extent in the Outline tab.

-

The layouts were previously a way to indicate the purpose of a specific novel document, like -whether it was a chapter or scene. With these layouts gone, the distinction is instead indicated by -other visual means.

-

The project index will now record the level of the first header of your document, and select a -different icon for documents with a partition, chapter or scene header. These are colour coded as -green, red, and blue respectively. The project notes have also received a new icon, with a yellow -colour code. Due to this change, the grey icon themes have been removed.

-

In addition, novel documents with a partition or chapter header will have the document label -viewed as bold and underlined. This feature can be disabled in Preferences if you want a cleaner -look in the project tree.

- -

Other Changes

-

Several improvements have been made to the project index, which means the index will be -automatically rebuilt when you open a project for the first time in the new version. You will get a -notification about this.

-

The ODT export tool has also been improved. The code that writes out text paragraphs has been -rewritten and now conforms more closely to the Open Document standard. Most of these improvements -will not be noticeable to you as a user, but you may notice that the exported document will now -allow multiple consecutive spaces. Previously, two spaces, or more, would be concatenated into a -single space in the exported document.

-

The internal spell check tool has been removed. If you want spell checking, you must install the -Spell Enchant tool. The internal spell checker was only ever added because the Python package for -Spell Enchant was not available on 64-bit Windows. This was corrected over a year ago. The main -issue with the internal spell checker was that it only included English, and the large dictionary -files had to be shipped with novelWriter.

-

Finally, a PDF version of the documentation should now be shipped with your install package. If -it is available, a "User Manual (PDF)" option should be visible in the Help menu. This should give -you access to the documentation also when you don't have an active internet connection.

- diff --git a/sample/nwProject.nwx b/sample/nwProject.nwx index 3038c132..c8245673 100644 --- a/sample/nwProject.nwx +++ b/sample/nwProject.nwx @@ -1,13 +1,13 @@ - + Sample Project Sample Project Jane Smith Jay Doh - 1265 + 1267 198 - 62062 + 62103 False