From 95aaf2e2d85a6263977219c341a0099b181052d9 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Tue, 17 Oct 2023 17:36:24 +0200 Subject: [PATCH] Update release to 2.1 and remove pre-release --- source/generated/checksum_block.rst | 24 +++--- source/generated/download_block.rst | 13 +-- source/generated/download_pre_release.rst | 100 +--------------------- source/generated/download_release.rst | 73 ++++++++-------- templates/download_block.rst | 1 + tools/assets.py | 3 +- update.py | 12 ++- 7 files changed, 69 insertions(+), 157 deletions(-) diff --git a/source/generated/checksum_block.rst b/source/generated/checksum_block.rst index bb8c354..c6f454a 100644 --- a/source/generated/checksum_block.rst +++ b/source/generated/checksum_block.rst @@ -1,14 +1,14 @@ Sha256 Checksums ---------------- -* | **Linux AppImage:** novelWriter-2.0.7-py3.10-manylinux_2_28_x86_64.AppImage - | Sha256: ``a493fbdb16f4ee9d63bf42568a0d057f9093fa9c69f9a6ba1d6c043673c3b2a4`` :octicon:`download` `ShaSum File `__ -* | **Debian Package:** novelwriter_2.0.7_all.deb - | Sha256: ``aeaa3e1bc797ea1527313e4b64b691a516b013e0e5d160e4644421881162736f`` :octicon:`download` `ShaSum File `__ -* | **Windows Installer:** novelwriter-2.0.7-py3.10.11-win10-amd64-setup.exe - | Sha256: ``342f4257bfbcbfa5fc0655c7f7c980c94fbc94967f0f91d2bc71d8a2b872ac88`` :octicon:`download` `ShaSum File `__ -* | **MacOS DMG Image:** novelWriter-2.0.7-macos.dmg - | Sha256: ``9e5fc4fd03e636f64e7b6ae38e52190f21d76b62a4519a746f853d4ebdeec3a0`` :octicon:`download` `ShaSum File `__ +* | **Linux AppImage:** novelWriter-2.1.AppImage + | Sha256: ``bdae7c23920097ff360b64937b999f8aaf42fa94c561dc6ffe2d80116ff21fb5`` :octicon:`download` `ShaSum File `__ +* | **Debian Package:** novelwriter_2.1_all.deb + | Sha256: ``66c4b1c0ca3c227c3f903cbb02b61024d0e5cc3846995d75f12c819e93e0c3b1`` :octicon:`download` `ShaSum File `__ +* | **Windows Installer:** novelwriter-2.1-amd64-setup.exe + | Sha256: ``cc96f2fafc1c5210949c70e0e9bf2b5ed7fdc133880228441a5377876978a478`` :octicon:`download` `ShaSum File `__ +* | **MacOS DMG Image:** novelWriter-2.1.dmg + | Sha256: ``e6d7cc7ef7ae84e8d23ec7c5d637752bf81a5224af5ebf748b1fb35e89bdcf7b`` :octicon:`download` `ShaSum File `__ .. rubric:: Verify the Checksum @@ -21,8 +21,8 @@ Sha256 Checksums .. code-block:: bash - shasum -c novelWriter-2.0.7-py3.10-manylinux_2_28_x86_64.AppImage.sha256 - shasum -c novelwriter_2.0.7_all.deb.sha256 + shasum -c novelWriter-2.1.AppImage.sha256 + shasum -c novelwriter_2.1_all.deb.sha256 .. tab-item:: Windows @@ -31,7 +31,7 @@ Sha256 Checksums .. code-block:: powershell - Get-FileHash -Algorithm SHA256 novelwriter-2.0.7-py3.10.11-win10-amd64-setup.exe | Format-List + Get-FileHash -Algorithm SHA256 novelwriter-2.1-amd64-setup.exe | Format-List .. tab-item:: MacOS @@ -40,4 +40,4 @@ Sha256 Checksums .. code-block:: bash - shasum -c novelWriter-2.0.7-macos.dmg.sha256 + shasum -c novelWriter-2.1.dmg.sha256 diff --git a/source/generated/download_block.rst b/source/generated/download_block.rst index 55f1fb5..5dcfea0 100644 --- a/source/generated/download_block.rst +++ b/source/generated/download_block.rst @@ -1,9 +1,9 @@ Latest Release ============== -.. _Release Notes: https://github.com/vkbo/novelWriter/releases/tag/v2.0.7 +.. _Release Notes: https://github.com/vkbo/novelWriter/releases/tag/v2.1 -**Version 2.0.7** -- Released on April 16, 2023 -- :octicon:`mark-github` `Release Notes`_ +**Version 2.1** -- Released on October 17, 2023 -- :octicon:`mark-github` `Release Notes`_ .. grid:: 1 1 3 3 :margin: 4 4 0 0 @@ -24,8 +24,8 @@ Latest Release :columns: 7 | **Download** - | :octicon:`download` `AppImage `__ - | :octicon:`download` `Debian Package `__ + | :octicon:`download` `AppImage `__ + | :octicon:`download` `Debian Package `__ .. grid-item:: :columns: 5 @@ -48,7 +48,7 @@ Latest Release :columns: 7 | **Download** - | :octicon:`download` `Setup Installer `__ + | :octicon:`download` `Setup Installer `__ | :octicon:`light-bulb` :ref:`Install Help ` .. grid-item:: @@ -72,7 +72,8 @@ Latest Release :columns: 7 | **Download** - | :octicon:`download` `DMG Image `__ + | :octicon:`download` `DMG Image `__ + | :octicon:`light-bulb` :ref:`Install Help ` .. grid-item:: :columns: 5 diff --git a/source/generated/download_pre_release.rst b/source/generated/download_pre_release.rst index 6da62cf..7a27a06 100644 --- a/source/generated/download_pre_release.rst +++ b/source/generated/download_pre_release.rst @@ -1,99 +1 @@ -.. _AppImage website: https://appimage.org/ -.. _Ubuntu: https://ubuntu.com/ -.. _Debian: https://www.debian.org/ -.. _Linux Mint: https://linuxmint.com/ -.. _novelWriter Repository: https://github.com/vkbo/novelWriter/ - -| **Release Version:** Release 2.1 RC 1 -| **Release Date:** August 31, 2023 -| **Release Page:** :octicon:`mark-github` `GitHub `__ - -.. dropdown:: Release Notes - :animate: fade-in-slide-down - :icon: info - - 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 take frequent backups. - - Please check the changelog for an overview of changes. The full release notes will be added to the final release. - -.. dropdown:: Detailed Changelog - :animate: fade-in-slide-down - :icon: tasklist - - **Bugfixes** - - * Fixed an issue where closing modal dialogs would close their parent. Issue `#1494 `_. PR `#1496 `_. - * The log output no longer prints an error message if the project does not have anything in its custom dictionary. PR `#1495 `_. - - **Usability** - - * novelWriter will no longer try to restore full screen mode if full screen was activated when it was last closed. This never worked right anyway. PR `#1498 `_. - * There are several usability updates for the Build Settings tool. Please check the PR for details. Some key changes are that the build dialogs are now children of the main GUI, so they can be moved freely from each other. The Selection page has been given a new look that should hopefully make it easier to understand, and the side bar for the tool has been redesigned. A few labels have also been changed to be easier to understand. Issue `#1497 `_. PR `#1499 `_. - * The alert and message boxes have been reimplemented with the full feature set of the Qt message box dialog instead of using the quick access functions with limited functionality. PR `#1501 `_. - * A project's spell check dictionary can now be set directly from the Tools menu. Issue `#1260 `_. PR `#1508 `_. - * The document details dialog box now shows a document's creation and update date if that has been set. Issue `#1423 `_. PR `#1510 `_. - * Moving the mouse wheel on any area within the border of the text editor or viewer will now scroll the document. Issue `#1425 `_. PR `#1511 `_. - - **Code Improvements** - - * A new shared data instance now owns the Gui Theme, the Project class and holds a link to the main Gui instance as well. This new class also handles message and alert boxes. The project instance is now destroyed and recreated between each project close/open cycle. This should guard better from project to project data leakage. PRs `#1502 `_ and `#1504 `_. - * The spell checker instance has been moved to the new shared data instance where it is destroyed and recreated together with the project instance. This blocks against bleed-through of the user's custom dictionary. PR `#1508 `_. - * Text hash (SHA1) and creation and update time stamps are now added to the document file's meta data section. The hash is used to detect file changes outside of novelWriter while documents are open. The old checker has been deleted. Issue `#1423 `_. PR `#1509 `_. - -Linux ------ - -**AppImage** - The AppImage should run on any recent Linux distro. See the `AppImage website`_ for more info. - - | **Download:** :octicon:`download` `novelWriter-2.1rc1.AppImage `__ [ 93.8 MB ] - | **Checksum:** :octicon:`hash` ``25809f2d0427851be9629fcd30efcd2aa38bdfa82b2ca63820c3c1a9b49e265e`` :octicon:`download` `ShaSum File `__ - -**AppImage (Legacy)** - For older Linux distros you may need to download this AppImage instead. - - | **Download:** :octicon:`download` `novelWriter-2.1rc1-oldlinux.AppImage `__ [ 93.6 MB ] - | **Checksum:** :octicon:`hash` ``32f712def7c4d90a1dc06cae23f99f7dd0d9a62c02373242957b2b0cc832db14`` :octicon:`download` `ShaSum File `__ - -**Debian Package** - The package is built for Debian_, but should also work for Ubuntu_ and `Linux Mint`_. - - | **Download:** :octicon:`download` `novelwriter_2.1rc1_all.deb `__ [ 1.94 MB ] - | **Checksum:** :octicon:`hash` ``577e163fd00ec862cfde1a326c94dd0d0d689a4991a1569a8862f6ef4594e38c`` :octicon:`download` `ShaSum File `__ - - -Windows -------- - -**Setup Installer** - This is a standard setup installer for Windows. It is made for Windows 10 or newer. - - | **Download:** :octicon:`download` `novelwriter-2.1rc1-amd64-setup.exe `__ [ 33.8 MB ] - | **Checksum:** :octicon:`hash` ``42dd2ce94ec7b45be276d0fd92b1b585986e41a1e072492752a6e6d293290f1d`` :octicon:`download` `ShaSum File `__ - - -MacOS ------ - -**DMG Image** - This is a DMG image for MacOS, and should work on MacOS 10 or higher. - - | **Download:** :octicon:`download` `novelWriter-2.1rc1.dmg `__ [ 91.1 MB ] - | **Checksum:** :octicon:`hash` ``c248f858463b15ee65fb27270c11869c23cd78b71e2f74ef76dba4fcbcb2f205`` :octicon:`download` `ShaSum File `__ - - -Other Packages --------------- - -**Python Wheel** - The Wheel package can be installed with ``pip install ``. - - | **Download:** :octicon:`download` `novelWriter-2.1rc1-py3-none-any.whl `__ [ 2.29 MB ] - | **Checksum:** :octicon:`hash` ``78e8e4488e7cf7a68a0472a5ab358f402fa2a9f58743e4511a8f6cf07965cea3`` :octicon:`download` `ShaSum File `__ - -**Source Code** -The source code packages are archived files of the entire source code. See also the `novelWriter Repository`_. - -| **Download:** :octicon:`download` `novelWriter-2.1rc1.zip `__ -| **Download:** :octicon:`download` `novelWriter-2.1rc1.tar.gz `__ - +*There is currently no pre-release available ...* \ No newline at end of file diff --git a/source/generated/download_release.rst b/source/generated/download_release.rst index 3c2864a..146fb97 100644 --- a/source/generated/download_release.rst +++ b/source/generated/download_release.rst @@ -4,44 +4,47 @@ .. _Linux Mint: https://linuxmint.com/ .. _novelWriter Repository: https://github.com/vkbo/novelWriter/ -| **Release Version:** Version 2.0.7 -| **Release Date:** April 16, 2023 -| **Release Page:** :octicon:`mark-github` `GitHub `__ +| **Release Version:** Version 2.1 +| **Release Date:** October 17, 2023 +| **Release Page:** :octicon:`mark-github` `GitHub `__ .. dropdown:: Release Notes :animate: fade-in-slide-down :icon: info - This is a patch release that fixes a few issues and adds a Japanese translation. + The primary focus of this release has been a complete redesign of the Build Tool, that is, the tool that assembles your project into a manuscript document. The new tool, called the "Manuscript Build Tool" allows you to define multiple build definitions for your project. The build definitions are edited in a new Manuscript Build Settings dialog, with a lot more options than the old tool. - The issues were mostly related to spell checking. In particular, issues with finding the word boundary when using underscore characters for italics markup. These issues should now be resolved. In addition, escaped markup characters are now rendered properly in HTML and ODT build formats. + The reason for this redesign is a long list of feature requests that could not easily be accommodated in the old, much simpler tool. Far from all the features have been added yet, but now that the new tool is in place, they will be gradually added in the coming releases. - A few usability improvements have also been made. The Add Item menu in the project tree no longer shows the options to create Novel Documents when an item in the tree is selected that cannot hold such a document. In addition, the "Change Label" context menu entry has been changed to say "Rename", which is a more logical choice. + The key feature added in this release is the extended control you now have for selecting exactly what part of your project is included in a given build definition. You have the same filters for selecting documents and notes, and turning on or off root folders as before, but you can now easily override on a per-document basis what is included or excluded in addition to the filter. + + A second major improvement is a better tool to format your manuscript headings. You no longer have to look up formatting codes and add them manually. Instead, there is now a heading format editor in the Build Settings dialog for creating the header format, with syntax highlighting included. + + **Other Changes** + + Among other features is a new option to duplicate documents and folders in the project tree. The duplicate feature is available from the right-click menu. A proper light colour theme has also been added. In most cases it will be the same as the default theme, depending on your platform. + + There are other, minor improvements as well, and a lot of code improvements under the hood. For a full list of changes, see the detailed changelogs. + + *These Release Notes also include the changes from the 2.1 Beta 1 and 2.1 RC 1 releases.* .. dropdown:: Detailed Changelog :animate: fade-in-slide-down :icon: tasklist - **Bugfixes** - - * Fixed an issue where novelWriter sometimes shows up in the desktop environment on Linux under another name than it's supposed to, which meant it would show up without the correct icon. The desktop environment was apparently guessing its name based on various values. It is now set explicitly. PR `#1405 `_. - * Fixed an issue where the syntax highlighting for spell checked words were not cleared when spell checking was disabled. Issue `#1414 `_. PR `#1416 `_. - * Fixed a series of issues with spell checking of words and sentences with italics styling using underscores. The spell checker relies on RegEx for splitting words, and RegEx considers the underscore a word character. Issue `#1415 `_. PR `#1417 `_. - * Fixed an issue where escaped markup characters were not being cleaned up when building HTML and ODT outputs. Issue `#1412 `_. PR `#1418 `_. - - **Usability Fixes** + **Usability** - * The context menu entry "Change Label" in the project tree has now been changed to say "Rename", which matches with the main menu, and is also more in line with what users expect. PR `#1403 `_. - * The entries for creating new Novel Documents in the project tree's Add Item menu are now hidden when the select item in the tree does not allow Novel Documents. This is less confusing than the previous behaviour where it would just create a Project Note regardless of selected file option. Issue `#1404 `_. PR `#1406 `_. + * A widget has been added to the Build Manuscript tool main window to show some select build settings for the selected build definition. This should make it a little easier to find the wanted build definition if there are many available. PR `#1516 `_. + * All columns on the Writing Stats tool now uses the same fixed width font. Issue `#1442 `_, PR `#1518 `_. - **Internationalisation** + **Documentation** - * Added Japanese translation, contributed by @hebekeg. PR `#1407 `_. - * Updated existing translations. PR `#1407 `_. + * The documentation has received significant updates for the 2.1 release. PR `#1531 `_. - **Packaging** + **Packaging and Installation** - * Legacy AppImage formats have been added to support glibc 2.24. This is a temporary solution until the AppImage base image is deprecated later in 2023. Issue `#1391 `_. PR `#1410 `_. + * Python 3.7 support has officially been dropped. Python 3.7 has reached end of life, and dropping it relaxes some restrictions on development. PR `#1515 `_. + * MacOS and Windows is now tested against Python 3.11, and 3.12 has been added to Linux. PR `#1515 `_. Linux ----- @@ -49,20 +52,20 @@ Linux **AppImage** The AppImage should run on any recent Linux distro. See the `AppImage website`_ for more info. - | **Download:** :octicon:`download` `novelWriter-2.0.7-py3.10-manylinux_2_28_x86_64.AppImage `__ [ 99.1 MB ] - | **Checksum:** :octicon:`hash` ``a493fbdb16f4ee9d63bf42568a0d057f9093fa9c69f9a6ba1d6c043673c3b2a4`` :octicon:`download` `ShaSum File `__ + | **Download:** :octicon:`download` `novelWriter-2.1.AppImage `__ [ 94.7 MB ] + | **Checksum:** :octicon:`hash` ``bdae7c23920097ff360b64937b999f8aaf42fa94c561dc6ffe2d80116ff21fb5`` :octicon:`download` `ShaSum File `__ **AppImage (Legacy)** For older Linux distros you may need to download this AppImage instead. - | **Download:** :octicon:`download` `novelWriter-2.0.7-py3.10-manylinux_2_24_x86_64.AppImage `__ [ 100 MB ] - | **Checksum:** :octicon:`hash` ``9f243a7bad56aa765dd1142ae2bccaedf2dba6e22e88038440f0698629ca6b02`` :octicon:`download` `ShaSum File `__ + | **Download:** :octicon:`download` `novelWriter-2.1-oldlinux.AppImage `__ [ 94.0 MB ] + | **Checksum:** :octicon:`hash` ``b7ccf55fc2b46ddecfefad92065d3de31d8b3d644127d6f137d6e47fbb9b0612`` :octicon:`download` `ShaSum File `__ **Debian Package** The package is built for Debian_, but should also work for Ubuntu_ and `Linux Mint`_. - | **Download:** :octicon:`download` `novelwriter_2.0.7_all.deb `__ [ 1.94 MB ] - | **Checksum:** :octicon:`hash` ``aeaa3e1bc797ea1527313e4b64b691a516b013e0e5d160e4644421881162736f`` :octicon:`download` `ShaSum File `__ + | **Download:** :octicon:`download` `novelwriter_2.1_all.deb `__ [ 2.49 MB ] + | **Checksum:** :octicon:`hash` ``66c4b1c0ca3c227c3f903cbb02b61024d0e5cc3846995d75f12c819e93e0c3b1`` :octicon:`download` `ShaSum File `__ Windows @@ -71,8 +74,8 @@ Windows **Setup Installer** This is a standard setup installer for Windows. It is made for Windows 10 or newer. - | **Download:** :octicon:`download` `novelwriter-2.0.7-py3.10.11-win10-amd64-setup.exe `__ [ 33.5 MB ] - | **Checksum:** :octicon:`hash` ``342f4257bfbcbfa5fc0655c7f7c980c94fbc94967f0f91d2bc71d8a2b872ac88`` :octicon:`download` `ShaSum File `__ + | **Download:** :octicon:`download` `novelwriter-2.1-amd64-setup.exe `__ [ 34.9 MB ] + | **Checksum:** :octicon:`hash` ``cc96f2fafc1c5210949c70e0e9bf2b5ed7fdc133880228441a5377876978a478`` :octicon:`download` `ShaSum File `__ MacOS @@ -81,8 +84,8 @@ MacOS **DMG Image** This is a DMG image for MacOS, and should work on MacOS 10 or higher. - | **Download:** :octicon:`download` `novelWriter-2.0.7-macos.dmg `__ [ 96.0 MB ] - | **Checksum:** :octicon:`hash` ``9e5fc4fd03e636f64e7b6ae38e52190f21d76b62a4519a746f853d4ebdeec3a0`` :octicon:`download` `ShaSum File `__ + | **Download:** :octicon:`download` `novelWriter-2.1.dmg `__ [ 93.2 MB ] + | **Checksum:** :octicon:`hash` ``e6d7cc7ef7ae84e8d23ec7c5d637752bf81a5224af5ebf748b1fb35e89bdcf7b`` :octicon:`download` `ShaSum File `__ Other Packages @@ -91,12 +94,12 @@ Other Packages **Python Wheel** The Wheel package can be installed with ``pip install ``. - | **Download:** :octicon:`download` `novelWriter-2.0.7-py3-none-any.whl `__ [ 2.31 MB ] - | **Checksum:** :octicon:`hash` ``28c4aca900afa65132f8be0c3bc164c4df2deaca399262499c3e270fcdbb98ac`` :octicon:`download` `ShaSum File `__ + | **Download:** :octicon:`download` `novelWriter-2.1-py3-none-any.whl `__ [ 2.87 MB ] + | **Checksum:** :octicon:`hash` ``dda7b8b991c35ce970e76b74b6b9d554c4f4c14a9845ae69d2763c2ef9a03809`` :octicon:`download` `ShaSum File `__ **Source Code** The source code packages are archived files of the entire source code. See also the `novelWriter Repository`_. -| **Download:** :octicon:`download` `novelWriter-2.0.7.zip `__ -| **Download:** :octicon:`download` `novelWriter-2.0.7.tar.gz `__ +| **Download:** :octicon:`download` `novelWriter-2.1.zip `__ +| **Download:** :octicon:`download` `novelWriter-2.1.tar.gz `__ diff --git a/templates/download_block.rst b/templates/download_block.rst index ffc2ce4..b75482a 100644 --- a/templates/download_block.rst +++ b/templates/download_block.rst @@ -73,6 +73,7 @@ Latest Release | **Download** | :octicon:`download` `DMG Image <{macdmg_download}>`__ + | :octicon:`light-bulb` :ref:`Install Help ` .. grid-item:: :columns: 5 diff --git a/tools/assets.py b/tools/assets.py index b806150..4f0f5ff 100644 --- a/tools/assets.py +++ b/tools/assets.py @@ -125,8 +125,7 @@ def assetSizeString(self): return fmtSize(self._size) def _processAsset(self): - """Process the raw asset data. - """ + """Process the raw asset data.""" data = self._raw name = data.get("name", "") if not name: diff --git a/update.py b/update.py index aeec1ba..718ef99 100755 --- a/update.py +++ b/update.py @@ -37,7 +37,7 @@ def ghLinks(x): buffer = [] for line in text.splitlines(): - if line.startswith("###"): + if line.startswith("### "): title = line.lstrip("#").lstrip() icon = None if "release" in title.lower(): @@ -48,6 +48,12 @@ def ghLinks(x): buffer.append(" :animate: fade-in-slide-down") if icon: buffer.append(f" :icon: {icon}") + elif line.startswith("#"): + title = line.lstrip("#").lstrip() + buffer.append(f" **{title}**") + elif line.startswith("_") and line.endswith("_"): + text = line.strip("_") + buffer.append(f" *{text}*") else: line = line.replace("`", "``") line = re.sub(r"#([0-9]+)\b", ghLinks, line) @@ -106,7 +112,7 @@ def pullRelease(args): if args.remove_pre: print("Removing Pre-Release") Path("source/generated/download_pre_release.rst").write_text( - "*There are currently no pre-releases available ...*", encoding="utf-8" + "*There is currently no pre-release available ...*", encoding="utf-8" ) return @@ -125,7 +131,7 @@ def pullRelease(args): with open(outDir / "api_data.json", mode="w") as apiDump: json.dump(data, apiDump, indent=2) - releaseUrl = data.get("html_url", "Unkown") + releaseUrl = data.get("html_url", "Unknown") releaseVersion = data.get("name", "Version ???") releaseDate = data.get("published_at", "") shortVersion = data.get("tag_name", "???").lstrip("v")