From c72e3a15856389bd7174badbfbd80eac14e5bf73 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Mon, 1 Feb 2021 21:17:30 +0100 Subject: [PATCH 1/3] Bumped version to 1.0.4 and updated changelog --- CHANGELOG.md | 37 +++++++++++++++++++++++++++++++++++++ docs/source/conf.py | 4 ++-- nw/__init__.py | 6 +++--- 3 files changed, 42 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 99087d0d..cd4d872d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,42 @@ # novelWriter Change Log +## Version 1.0.4 [2021-02-07] + +### Release Notes + +### Detailed Changelog + +**Bug Fixes** + +* Fixed an issue where the setting for justified text in the text editor was in the Preferences + dialog mixed with the setting for fixed text width in the editor. This meant that the justified + text setting could potentially get overridden when the Preferences dialog was used. Issue #623, + PR #625. +* Fixed an issue with the Open Project dialog where the list of recent projects would contain + duplicate entries if the dialog was opened multiple times. PR #627. + +**User Interface** + +* The `Ctrl+Del` keyboard shortcut is now only active when the project tree has focus. Since this + is also a common used shortcut in many application for deleting the next word, the deletion of a + file when the key combination is used in the editor is unexpected. Issue #629, PR #631. + +**Installation** + +* A new command has been added to the `setup.py` script. The new command, `win-install`, will + create a desktop and start menu icon for novelWriter when run in the source folder. A windows + batch file, `win_install.bat`, has also been added. Running this file from the source folder, + either by command line or by double-click, will install dependencies from PyPi and set up the + icons. This should make it easier to run novelWriter from the source folder on Windows. PR #634. + +**Documentation** + +* The documentation on how to setup and install novelWriter has been extended and reorganised into + one file per operating system. Some of the other documentation files have also been moved to a + new section. PR #634. + +---- + ## Version 1.0.3 [2021-01-24] ### Release Notes diff --git a/docs/source/conf.py b/docs/source/conf.py index 707ae026..e93f7bcc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -25,9 +25,9 @@ copyright = "2018–2021, Veronica Berglyd Olsen" author = "Veronica Berglyd Olsen" # The short X.Y version -version = "1.0.3" +version = "1.0.4" # The full version, including alpha/beta/rc tags -release = "1.0.3" +release = "1.0.4" # -- General configuration --------------------------------------------------- diff --git a/nw/__init__.py b/nw/__init__.py index 38c98cda..7f91572e 100644 --- a/nw/__init__.py +++ b/nw/__init__.py @@ -63,9 +63,9 @@ __license__ = "GPLv3" __author__ = "Veronica Berglyd Olsen" __maintainer__ = "Veronica Berglyd Olsen" __email__ = "code@vkbo.net" -__version__ = "1.0.3" -__hexversion__ = "0x010003f0" -__date__ = "2021-01-24" +__version__ = "1.0.4" +__hexversion__ = "0x010004f0" +__date__ = "2021-02-07" __status__ = "Stable" __domain__ = "novelwriter.io" __url__ = "https://novelwriter.io" From c0dee497cdd414359779c16551ae9615fbb7adfc Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Wed, 3 Feb 2021 19:38:34 +0100 Subject: [PATCH 2/3] Updated readme and changelog --- CHANGELOG.md | 28 ++++++++++++++++++---------- README.md | 12 ++++++++---- 2 files changed, 26 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cd4d872d..c8462f0e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,36 +4,44 @@ ### Release Notes +This patch release fixes a couple of minor issues with the Preferences dialog and the behaviour of +one of the keyboard shortcuts. + +Aside from these fixes, the main point of this patch is to add new setup features for novelWriter +on Windows. A Windows installer will no longer be provided for the foreseeable future, and instead +functionality has been added to the main setup script to create desktop and start menu icons. + ### Detailed Changelog **Bug Fixes** -* Fixed an issue where the setting for justified text in the text editor was in the Preferences - dialog mixed with the setting for fixed text width in the editor. This meant that the justified - text setting could potentially get overridden when the Preferences dialog was used. Issue #623, - PR #625. +* Fixed an issue with the Preferences dialog where the setting for justified text was mixed with + the setting for fixed text width. This meant that the justified text setting could potentially + get overwritten when the Preferences were changed and saved. Issue #623, PR #625. * Fixed an issue with the Open Project dialog where the list of recent projects would contain duplicate entries if the dialog was opened multiple times. PR #627. **User Interface** * The `Ctrl+Del` keyboard shortcut is now only active when the project tree has focus. Since this - is also a common used shortcut in many application for deleting the next word, the deletion of a - file when the key combination is used in the editor is unexpected. Issue #629, PR #631. + is also a common shortcut in many applications for deleting the next word ahead of the cursor, + the activation of the delete file function when the editor has focus is unexpected to some users. + Issue #629, PR #631. **Installation** * A new command has been added to the `setup.py` script. The new command, `win-install`, will create a desktop and start menu icon for novelWriter when run in the source folder. A windows - batch file, `win_install.bat`, has also been added. Running this file from the source folder, + batch file, `setup_windows.bat`, has also been added. Running this file from the source folder, either by command line or by double-click, will install dependencies from PyPi and set up the - icons. This should make it easier to run novelWriter from the source folder on Windows. PR #634. + icons and file association with novelWriter project files. This should make it easier to run + novelWriter from the source folder on Windows. PRs #634 and #641. **Documentation** * The documentation on how to setup and install novelWriter has been extended and reorganised into one file per operating system. Some of the other documentation files have also been moved to a - new section. PR #634. + different section. PR #634. ---- @@ -917,7 +925,7 @@ planned by GitHub. See their [notes](https://github.com/github/renaming) for mor **Other Changes** * The install scripts now try to create folders before copying icons. PR #364. -* The manifest file now lists the root assets folder, so that it is included in the pypi build. PR +* The manifest file now lists the root assets folder, so that it is included in the PyPi build. PR #364. * The .desktop template file has the correct categories set according to the FreeDesktop standard. PR #364. diff --git a/README.md b/README.md index 033035fa..3191b339 100644 --- a/README.md +++ b/README.md @@ -191,9 +191,13 @@ novelWriter ### Setup on Windows -For Windows, you can either install via PyPi, or use the Windows installer available from the -[releases](https://github.com/vkbo/novelWriter/releases) page. This should add the necessary icons -to your desktop and start menu. +For Windows, first ensure that you have Python installed. If not, get it from +[python.org/downloads](https://www.python.org/downloads/). Remember to select "Add Python to PATH" +during the installation, otherwise novelWriter cannot find it. + +Then, download the `Source code` zip file from the Release page, extract it to wherever you want to +keep novelWriter on your PC, and run the `setup_windows.bat` file in it. This will install the +necessary dependencies from [pypi,org](https://pypi.org/) and create desktop and start menu icons. ## Debugging @@ -211,7 +215,7 @@ details, or consult the [LICENSE](https://github.com/vkbo/novelWriter/blob/main/ Bundled assets have the following licenses: -* The Typicon-based icon themes by Stephen Hutchings are licensed under +* The Typicons-based icon themes by Stephen Hutchings are licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/). The icons have been altered in size and colour for use with novelWriter, and some additional icons added. The original icon set is available at From caa601c9aafe8ef02ed6d87ef532f694a51e9c43 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Wed, 3 Feb 2021 20:52:36 +0100 Subject: [PATCH 3/3] Update of release notes and changelog before release 1.0.4 --- CHANGELOG.md | 2 +- docs/source/setup_windows.rst | 17 +++++++++-------- nw/__init__.py | 2 +- nw/assets/text/release_notes.htm | 17 ++++++++++++++--- sample/nwProject.nwx | 6 +++--- 5 files changed, 28 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c8462f0e..fc4ed868 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,7 +35,7 @@ functionality has been added to the main setup script to create desktop and star batch file, `setup_windows.bat`, has also been added. Running this file from the source folder, either by command line or by double-click, will install dependencies from PyPi and set up the icons and file association with novelWriter project files. This should make it easier to run - novelWriter from the source folder on Windows. PRs #634 and #641. + novelWriter from the source folder on Windows. PRs #634, #641 and #642. **Documentation** diff --git a/docs/source/setup_windows.rst b/docs/source/setup_windows.rst index 858286ff..4a2f35a9 100644 --- a/docs/source/setup_windows.rst +++ b/docs/source/setup_windows.rst @@ -21,7 +21,7 @@ Using the Installer =================== The installer for Windows is no longer provided. You can still create it yourself if you want to. -It can be generated with the provided `setup.py` script. use the script's `help` command to get +It can be generated with the provided ``setup.py`` script. use the script's ``help`` command to get further instructions. Please use the "Running from Source" option below instead. @@ -33,11 +33,12 @@ Running from Source =================== To run novelWriter from source, download the latest source zip file from the release page on -GitHub_ or the `main website`_, or if you have git running on your computer, you can also clone the -repository. +GitHub_ or the `main website`_. The file named ``novelWriter-x.y.z-minimal.zip``, where ``x.y.z`` +is the version number, is ideal for this. You can also download the full source. In order to make novelWriter run on your system, you must first have Python installed (Step 1). -Thereafter, a script will do the rest of the job (Step 2). or you can do it yourself manually. +Thereafter, a script will do the rest of the job (Step 2). or you can do it yourself manually if +you wish to. .. _GitHub: https://github.com/vkbo/novelWriter/releases .. _main website: https://novelwriter.io @@ -50,8 +51,8 @@ If you already have Python installed, you can skip this step. If you don't have can download it from the python.org_ website. novelWriter should work with Python 3.6 or higher, but it is recommended that you install the latest version of Python. -Also, make sure you select the "Add Python to PATH" option during installation, otherwise the -``python`` command will not work in the command line window. +Make sure you select the "Add Python to PATH" option during installation, otherwise the ``python`` +command will not work in the command line window. .. image:: images/python_win_install.png :width: 600 @@ -66,8 +67,8 @@ Step 2: Dependencies and Icons Open the folder where you extracted the novelWriter source, and double-click the file named ``setup_windows`` or ``setup_windows.bat``. This should open a command line window and run the -setup script to install dependencies, and desktop and start menu icons. It will also check that it -can find Python from Step 1. +setup script to install dependencies, and add desktop and start menu icons. It will also check that +it can find Python from Step 1. .. note:: If you upgrade Python to a newer version and the path to ``pythonw.exe`` changes, you may need diff --git a/nw/__init__.py b/nw/__init__.py index 7f91572e..5900aeaa 100644 --- a/nw/__init__.py +++ b/nw/__init__.py @@ -65,7 +65,7 @@ __maintainer__ = "Veronica Berglyd Olsen" __email__ = "code@vkbo.net" __version__ = "1.0.4" __hexversion__ = "0x010004f0" -__date__ = "2021-02-07" +__date__ = "2021-02-03" __status__ = "Stable" __domain__ = "novelwriter.io" __url__ = "https://novelwriter.io" diff --git a/nw/assets/text/release_notes.htm b/nw/assets/text/release_notes.htm index 7052b51c..789ef644 100644 --- a/nw/assets/text/release_notes.htm +++ b/nw/assets/text/release_notes.htm @@ -2,6 +2,20 @@ +

Release Notes for 1.0.4

+

Released on 3 February 2021

+

This patch release fixes a couple of minor issues with the Preferences dialog and the behaviour +of one of the keyboard shortcuts.

+

Aside from these fixes, the main point of this patch is to add new setup features for +novelWriter on Windows. A Windows installer will no longer be provided for the foreseeable future, +and instead functionality has been added to the main setup script to create desktop and start menu +icons.

+ +

The full changelog is available +here.

+ +
+

Release Notes for 1.0.3

Released on 24 January 2021

This patch release fixes a minor bug sometimes encountered when running novelWriter from command @@ -14,9 +28,6 @@ file .pyz. The executable would often be mistakenly flagged by virus cont the packaging tools. This is a known problem with pyinstaller and similar tools, but such warnings are always concerning even if they are false positives.

-

The full changelog is available -here.

-

Release Notes for 1.0.2

diff --git a/sample/nwProject.nwx b/sample/nwProject.nwx index fd136fe7..c9c19a12 100644 --- a/sample/nwProject.nwx +++ b/sample/nwProject.nwx @@ -1,13 +1,13 @@ - + Sample Project Sample Project Jane Smith Jay Doh - 830 + 832 153 - 39583 + 39614 False