Skip to content

Commit

Permalink
Release 2.3 RC 1
Browse files Browse the repository at this point in the history
  • Loading branch information
@vkbo
vkbo committed Feb 24, 2024
1 parent aa08802 commit 7a6712f
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 47 deletions.
2 changes: 1 addition & 1 deletion source/docs/int_howto.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Organising Your Text
within chapters. Like for instance if you switch point-of-view character often.

In such cases you may want to use the scene heading for hard scene breaks and section headings
for soft scene breaks. the :guilabel:`Build Manuscript` tool will let you add separate
for soft scene breaks. The :guilabel:`Build Manuscript` tool will let you add separate
formatting for the two when you generate your manuscript. You can for instance add the common
"``* * *``" for hard breaks and select to hide section breaks, which will just insert an empty
paragraph in their place. See :ref:`a_manuscript_settings` for more details.
Expand Down
64 changes: 42 additions & 22 deletions source/docs/project_references.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Tags and References
*******************

In novelWriter there are no forms or tables to fill in to define the characters, locations and
other elements of your story. Instead, you can mark your :term:`project notes` as representing
these story elements by creating a :term:`tag`. Whenever you want to link a piece of your story to
a note defining a story element, like a character, you create a :term:`reference` back to that tag.
You can also cross-link your project notes in the same way.
other elements of your story. Instead, you create :term:`project notes` which you can mark as
representing these story elements by creating a :term:`tag`. Whenever you want to link a piece of
your story to a note defining a story element, like a character, you create a :term:`reference`
back to that tag. You can also cross-link your project notes in the same way.

This is perhaps one of the features that makes novelWriter different from other, similar
applications. It is therefore not always obvious to new users how this is supposed to work, so
this chapter hopes to explains in more detail how to use the tags and references system.
this chapter hopes to explain in more detail how to use this tags and references system.

.. tip::
If you find the Tags and Reference system difficult to follow just from reading this chapter,
Expand Down Expand Up @@ -47,16 +47,28 @@ How to Use Tags
===============

A "tag" in novelWriter is a word or phrase that you define as belonging to a heading. Tags are set
by using the ``@tags`` :term:`keyword`. The full format of a tag is ``@tag: tagname``, where
``tagname`` is an identifier of your choosing. You can only set *one* tag per heading, and the tag
has to be unique across all documents in the project.
by using the ``@tag`` :term:`keyword`.

.. versionadded:: 2.2
Tags are now case insensitive.
The basic format of a tag is ``@tag: tagName``.

The full format of a tag is ``@tag: tagName | displayName``.

``tagName`` (Required)
This is a unique identifier of your choosing. It is the value you use later for making
references back to this document, or section of the document.

``displayName`` (Optional)
This is an optional display name used for the tag. When you build your manuscript, you can for
instance insert the point of view character name into chapter headings. By default, the
``tagName`` value is used in headings, but if you use a shortened format internally in your
project, you can use this to specify a more suitable format for your manuscript headings.

After the tags have been defined, they can then be referenced in the novel documents, or
cross-referenced in other notes. they will also show up in the :guilabel:`Outline View` and in the
back-reference panel when a document is opened in the viewer.
You can only set *one* tag per heading, and the tag has to be unique across *all* documents in the
project.

After a tag has been defined, it can be referenced in novel documents, or cross-referenced in other
notes. Tags will also show up in the :guilabel:`Outline View` and in the back-reference panel when
a document is opened in the viewer.

The syntax highlighter will indicate to you that the keyword is correctly used and that the tag is
allowed, that is, the tag is unique. Duplicate tags should be detected as long as the index is up
Expand All @@ -68,22 +80,30 @@ there for you to use in whatever way you wish. Of course, the content of the doc
to the manuscript, or an outline document. If you want to compile a single document of all your
notes, you can do this from the :guilabel:`Manuscript Build` tool.

.. versionadded:: 2.2
Tags are no longer case sensitive. The tags are by default displayed with the capitalisation you
use when defining the tag, but you don't have to use the same capitalisation when referencing
it later.

.. versionadded:: 2.3
Tags can have an optional display name for manuscript builds.

Example of a heading with a tag for a character of the story:

.. code-block:: none
.. code-block:: md
# Jane Doe
# Character: Jane Doe
@tag: Jane
@tag: Jane | Jane Doe
Some information about the character Jane Doe.
When this is done in a document in a :term:`Root Folder` of type "Characters", the tag is
automatically treated as an available character in your project, and you will be able to reference
it in any of your other documents using the reference keywords for characters. It will also show up
in the Character tab in the Reference panel below the document viewer, and in the reference
auto-completer menu in the editor when you fill in references. See :ref:`a_ui_view` and
:ref:`a_references_completer`.
automatically treated as an available character in your project with the value "Jane", and you will
be able to reference it in any of your other documents using the reference keywords for characters.
It will also show up in the Character tab in the Reference panel below the document viewer, and in
the reference auto-completer menu in the editor when you fill in references. See :ref:`a_ui_view`
and :ref:`a_references_completer`.

It is the root folder type that defines what category of story elements the tag is indexed under.
See the :ref:`a_proj_roots` section for an overview of available root folder types. They are also
Expand Down Expand Up @@ -172,7 +192,7 @@ highlight that two notes are related.

Example of a novel document with references to characters and plots:

.. code-block:: none
.. code-block:: md
## Chapter 1
Expand Down
37 changes: 22 additions & 15 deletions source/generated/download_pre_release.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,31 @@
.. _Linux Mint: https://linuxmint.com/
.. _novelWriter Repository: https://github.com/vkbo/novelWriter/

| **Release Version:** Version 2.3 Beta 1
| **Release Date:** February 16, 2024
| **Release Version:** Version 2.3 RC 1
| **Release Date:** February 24, 2024
| **Release Notes:** :ref:`main_release_2_3`
| **GitHub Release:** :octicon:`mark-github` `GitHub <https://github.com/vkbo/novelWriter/releases/tag/v2.3b1>`__
| **GitHub Release:** :octicon:`mark-github` `GitHub <https://github.com/vkbo/novelWriter/releases/tag/v2.3rc1>`__
Linux
-----

**AppImage**
The AppImage should run on any recent Linux distro. See the `AppImage website`_ for more info.

| **Download:** :octicon:`download` `novelWriter-2.3b1.AppImage <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelWriter-2.3b1.AppImage>`__ [ 95.2 MB ]
| **Checksum:** :octicon:`hash` ``252d810390f5c70decd5405b46fac515fa13755187968c5d4b6233f1af4997fa`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelWriter-2.3b1.AppImage.sha256>`__
| **Download:** :octicon:`download` `novelWriter-2.3rc1.AppImage <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelWriter-2.3rc1.AppImage>`__ [ 95.2 MB ]
| **Checksum:** :octicon:`hash` ``0e2c5f263b07a915791c99b71c95ec5f56a3dd12594b2fc61c37bc840c9b4482`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelWriter-2.3rc1.AppImage.sha256>`__
**AppImage (Legacy)**
For older Linux distros you may need to download this AppImage instead.

| **Download:** :octicon:`download` `novelWriter-2.3b1-oldlinux.AppImage <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelWriter-2.3b1-oldlinux.AppImage>`__ [ 94.9 MB ]
| **Checksum:** :octicon:`hash` ``d21225ef412f848ed6988370e73ffa30cd1e123775a0f98d59e036571615f414`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelWriter-2.3b1-oldlinux.AppImage.sha256>`__
| **Download:** :octicon:`download` `novelWriter-2.3rc1-oldlinux.AppImage <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelWriter-2.3rc1-oldlinux.AppImage>`__ [ 94.9 MB ]
| **Checksum:** :octicon:`hash` ``3cd1713d6d0095c7efde83cc6e8f43f18259f82adb5448e9cfafe5799f99dbd4`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelWriter-2.3rc1-oldlinux.AppImage.sha256>`__
**Debian Package**
The package is built for Debian_, but should also work for Ubuntu_ and `Linux Mint`_.

| **Download:** :octicon:`download` `novelwriter_2.3.rc1_all.deb <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelwriter_2.3.rc1_all.deb>`__ [ 3.28 MB ]
| **Checksum:** :octicon:`hash` ``a90baa297cc1f26b97495f86784c57736333122c82bc8b2174f8315ca6bac943`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelwriter_2.3.rc1_all.deb.sha256>`__

Windows
Expand All @@ -31,8 +37,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.3b1-amd64-setup.exe <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelwriter-2.3b1-amd64-setup.exe>`__ [ 36.3 MB ]
| **Checksum:** :octicon:`hash` ``e7941cb0d46dd71779b1ab03b22b184a54654efd4f3af1bd675f2c9a623e1216`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelwriter-2.3b1-amd64-setup.exe.sha256>`__
| **Download:** :octicon:`download` `novelwriter-2.3rc1-amd64-setup.exe <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelwriter-2.3rc1-amd64-setup.exe>`__ [ 36.3 MB ]
| **Checksum:** :octicon:`hash` ``6010725cf2481da5a44d37149f8bd17e26498b23076b8cb8c0ae8e9298dc306a`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelwriter-2.3rc1-amd64-setup.exe.sha256>`__

MacOS
Expand All @@ -41,8 +47,8 @@ MacOS
**DMG Image**
This is a DMG image for MacOS, and should work on at least MacOS 12 or higher.

| **Download:** :octicon:`download` `novelWriter-2.3b1.dmg <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelWriter-2.3b1.dmg>`__ [ 92.7 MB ]
| **Checksum:** :octicon:`hash` ``0cb2fa5e3c9574b34cd3870ade80691370fe32d800507ba19505105a2b84adac`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelWriter-2.3b1.dmg.sha256>`__
| **Download:** :octicon:`download` `novelWriter-2.3rc1.dmg <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelWriter-2.3rc1.dmg>`__ [ 92.7 MB ]
| **Checksum:** :octicon:`hash` ``298355880fe5dc0bc0086506cfdab9e5809612118238dea6ef01eab9d25af322`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelWriter-2.3rc1.dmg.sha256>`__

Other Packages
Expand All @@ -51,11 +57,12 @@ Other Packages
**Python Wheel**
The Wheel package can be installed with ``pip install <file_path>``.

| **Download:** :octicon:`download` `novelWriter-2.3b1-py3-none-any.whl <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelWriter-2.3b1-py3-none-any.whl>`__ [ 3.73 MB ]
| **Checksum:** :octicon:`hash` ``1a5ba42b48219ecc9c417dd3dc3c8fb7504f082666a310c49e3a9df94b0d0f6c`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3b1/novelWriter-2.3b1-py3-none-any.whl.sha256>`__
| **Download:** :octicon:`download` `novelWriter-2.3rc1-py3-none-any.whl <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelWriter-2.3rc1-py3-none-any.whl>`__ [ 3.73 MB ]
| **Checksum:** :octicon:`hash` ``893c45a20017bfafa93ed2a99196c02d80807e2c15fcb129d4e8889ff4553db3`` :octicon:`download` `ShaSum File <https://github.com/vkbo/novelWriter/releases/download/v2.3rc1/novelWriter-2.3rc1-py3-none-any.whl.sha256>`__
**Source Code**
The source code packages are archived files of the entire source code. See also the `novelWriter Repository`_.

| **Download:** :octicon:`download` `novelWriter-2.3b1.zip <https://api.github.com/repos/vkbo/novelWriter/zipball/v2.3b1>`__
| **Download:** :octicon:`download` `novelWriter-2.3b1.tar.gz <https://api.github.com/repos/vkbo/novelWriter/tarball/v2.3b1>`__
| **Download:** :octicon:`download` `novelWriter-2.3rc1.zip <https://api.github.com/repos/vkbo/novelWriter/zipball/v2.3rc1>`__
| **Download:** :octicon:`download` `novelWriter-2.3rc1.tar.gz <https://api.github.com/repos/vkbo/novelWriter/tarball/v2.3rc1>`__
25 changes: 16 additions & 9 deletions source/releases/release_2_3.rst
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. _main_release_2_3:

**********************
Pre-Release 2.3 Beta 1
**********************
********************
Pre-Release 2.3 RC 1
********************

| **Release Date:** February 16, 2024
| **Release Date:** February 24, 2024
Release Notes
=============
Expand Down Expand Up @@ -127,16 +127,23 @@ Among other, smaller improvements are:
for instance Excel or Open Office Calc. The export is initiated from a new "Export CSV" button in the toolbar above the outline.


Next Pre-Release
----------------
Further Details
---------------

The next upcoming pre-release of novelWriter 2.3 will be 2.3 RC 1.
The next upcoming release of novelWriter is 2.3.

You can follow the development progress on the `2.3 RC 1 Milestone <https://github.com/vkbo/novelWriter/milestone/72>`__.
You can follow the development progress on the `2.3 Milestone <https://github.com/vkbo/novelWriter/milestone/73>`__.

Feedback for the 2.3 Beta 1 release can be posted on the `GitHub Discussions <https://github.com/vkbo/novelWriter/discussions/1699>`__ thread.
Feedback for the 2.3 RC 1 release can be posted on the `GitHub Discussions <https://github.com/vkbo/novelWriter/discussions/1713>`__ thread.

Download Links
==============

.. include:: ../generated/download_pre_release.rst

Other Packages
==============

Past release packages are available for download on `GitHub <https://github.com/vkbo/novelWriter/releases>`__.

| :octicon:`mark-github` `Download Release 2.3 Beta 1 <https://github.com/vkbo/novelWriter/releases/tag/v2.3b1>`__

0 comments on commit 7a6712f

Please sign in to comment.