Release 2.6 (#2208)

Signed-off-by: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>

.github/workflows/build_assets.yml

@@ -0,0 +1,39 @@
+name: BuildAssets
+
+on: workflow_call
+
+jobs:
+  buildAssets:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          architecture: x64
+
+      - name: Install Packages (apt)
+        run: |
+          sudo apt update
+          sudo apt install qttools5-dev-tools latexmk texlive texlive-latex-extra
+
+      - name: Checkout Source
+        uses: actions/checkout@v4
+
+      - name: Install Packages (pip)
+        run: pip install -r docs/source/requirements.txt
+
+      - name: Build Assets
+        run: |
+          python pkgutils.py build-assets
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: nw-assets
+          path: |
+            novelwriter/assets/manual.pdf
+            novelwriter/assets/sample.zip
+            novelwriter/assets/i18n/*.qm
+          if-no-files-found: error
+          retention-days: 14

.github/workflows/build_linux.yml

@@ -0,0 +1,46 @@
+name: BuildLinux
+
+on: workflow_dispatch
+
+jobs:
+  buildAssets:
+    uses: ./.github/workflows/build_assets.yml
+
+  buildLinux-AppImage:
+    needs: buildAssets
+    runs-on: ubuntu-latest
+    env:
+      PYTHON_VERSION: "3.12"
+      LINUX_TAG: "manylinux_2_28_x86_64"
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          architecture: x64
+
+      - name: Install Packages (pip)
+        run: pip install python-appimage
+
+      - name: Checkout Source
+        uses: actions/checkout@v4
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: nw-assets
+          path: novelwriter/assets
+
+      - name: Build AppImage
+        id: build
+        run: |
+          echo "BUILD_VERSION=$(python pkgutils.py version)" >> $GITHUB_OUTPUT
+          python pkgutils.py build-appimage --linux-tag $LINUX_TAG --python-version $PYTHON_VERSION
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: novelWriter-${{ steps.build.outputs.BUILD_VERSION }}-Linux-AppImage
+          path: dist_appimage/*.AppImage*
+          if-no-files-found: error
+          retention-days: 14

.github/workflows/build_mac.yml

@@ -0,0 +1,69 @@
+name: BuildMacOS
+
+on: workflow_dispatch
+
+jobs:
+  buildAssets:
+    uses: ./.github/workflows/build_assets.yml
+
+  buildMac-AMD64:
+    needs: buildAssets
+    runs-on: macos-latest
+    env:
+      PYTHON_VERSION: "3.12"
+      PACKAGE_ARCH: x86_64
+      MINICONDA_ARCH: x86_64
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: nw-assets
+          path: novelwriter/assets
+
+      - name: Build App Bundle
+        id: build
+        run: |
+          echo "BUILD_VERSION=$(python pkgutils.py version)" >> $GITHUB_OUTPUT
+          ./setup/macos/build.sh $PYTHON_VERSION $PACKAGE_ARCH $MINICONDA_ARCH
+
+      - name: Upload DMG
+        uses: actions/upload-artifact@v4
+        with:
+          name: novelWriter-${{ steps.build.outputs.BUILD_VERSION }}-MacOS-AMD64-DMG
+          path: dist_macos/*.dmg*
+          if-no-files-found: error
+          retention-days: 14
+
+  buildMac-M1:
+    needs: buildAssets
+    runs-on: macos-latest
+    env:
+      PYTHON_VERSION: "3.12"
+      PACKAGE_ARCH: aarch64
+      MINICONDA_ARCH: arm64
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: nw-assets
+          path: novelwriter/assets
+
+      - name: Build App Bundle
+        id: build
+        run: |
+          echo "BUILD_VERSION=$(python pkgutils.py version)" >> $GITHUB_OUTPUT
+          ./setup/macos/build.sh $PYTHON_VERSION $PACKAGE_ARCH $MINICONDA_ARCH
+
+      - name: Upload DMG
+        uses: actions/upload-artifact@v4
+        with:
+          name: novelWriter-${{ steps.build.outputs.BUILD_VERSION }}-MacOS-M1-DMG
+          path: dist_macos/*.dmg*
+          if-no-files-found: error
+          retention-days: 14

.github/workflows/build_win.yml

@@ -0,0 +1,62 @@
+name: BuildWindows
+
+on: workflow_dispatch
+
+jobs:
+  buildAssets:
+    uses: ./.github/workflows/build_assets.yml
+
+  buildWin64:
+    needs: buildAssets
+    runs-on: windows-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          architecture: x64
+
+      - name: Checkout Source
+        uses: actions/checkout@v4
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: nw-assets
+          path: novelwriter/assets
+
+      - name: Build Setup Installer
+        id: build
+        run: |
+          echo "BUILD_VERSION=$(python pkgutils.py version)" >> $Env:GITHUB_OUTPUT
+          python pkgutils.py build-win-exe
+
+      - name: Upload Unsigned Artifacts
+        id: upload-unsigned-artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: novelWriter-${{ steps.build.outputs.BUILD_VERSION }}-Win-Setup
+          path: dist/*.exe
+          if-no-files-found: error
+          retention-days: 14
+
+      - name: Submit Signing Request
+        uses: signpath/github-action-submit-signing-request@v1
+        with:
+          api-token: "${{ secrets.SIGNPATH_API_TOKEN }}"
+          organization-id: "0471e52c-66fa-4e9a-bfb9-36167095ca3f"
+          project-slug: "novelWriter"
+          signing-policy-slug: "release-signing "
+          github-artifact-id: "${{ steps.upload-unsigned-artifact.outputs.artifact-id }}"
+          wait-for-completion: true
+          output-artifact-directory: "dist/"
+          parameters: |
+            version: "${{ steps.build.outputs.BUILD_VERSION }}"
+
+      - name: Upload Signed Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: novelWriter-${{ steps.build.outputs.BUILD_VERSION }}-Win-Setup-Signed
+          path: dist/*.exe
+          if-no-files-found: error
+          retention-days: 14

.github/workflows/i18n.yml

@@ -0,0 +1,32 @@
+name: i18n
+
+on:
+  push:
+    branches:
+      - i18n/*
+
+jobs:
+  buildI18n:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          architecture: x64
+      - name: Install Packages (apt)
+        run: |
+          sudo apt update
+          sudo apt install qttools5-dev-tools
+      - name: Checkout Source
+        uses: actions/checkout@v4
+      - name: Build Assets
+        run: python pkgutils.py qtlrelease
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: nw-i18n
+          path: |
+            novelwriter/assets/i18n/*.qm
+          if-no-files-found: error
+          retention-days: 7

.github/workflows/syntax.yml

@@ -1,33 +1,30 @@
-name: flake8
+name: Flake8
 
 on:
   push:
-    branches: 
+    branches:
       - main
-      - patch
+      - release
   pull_request:
     branches:
       - main
-      - patch
+      - release
 
 jobs:
   checkSyntax:
     runs-on: ubuntu-latest
     steps:
       - name: Python Setup
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3
           architecture: x64
       - name: Checkout Source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install flake8
-        run: pip install flake8
-      - name: Syntax Error Check
+        run: pip install -r requirements-dev.txt
+      - name: Syntax Check
         run: |
-          flake8 novelwriter --count --select=E9,F63,F7,F82 --show-source --statistics
-          flake8 tests --count --select=E9,F63,F7,F82 --show-source --statistics
-      - name: Coding Style Violations
-        run: | 
-          flake8 novelwriter --count --max-line-length=99 --ignore E133,E221,E226,E228,E241,W503 --show-source --statistics
-          flake8 tests --count --max-line-length=99 --ignore E133,E221,E226,E228,E241,W503 --show-source --statistics
+          flake8 --version
+          flake8 novelwriter --count --show-source --statistics
+          flake8 tests --count --show-source --statistics --extend-ignore ANN

.github/workflows/test_linux.yml

@@ -2,42 +2,45 @@ name: Linux
 
 on:
   push:
-    branches: 
+    branches:
       - main
-      - patch
+      - release
   pull_request:
     branches:
       - main
-      - patch
+      - release
 
 jobs:
   testLinux:
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+      fail-fast: false
     runs-on: ubuntu-latest
     steps:
       - name: Python Setup
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
       - name: Install Packages (apt)
         run: |
           sudo apt update
-          sudo apt install libenchant-dev qttools5-dev-tools aspell-en
+          sudo apt install libenchant-2-dev qttools5-dev-tools aspell-en
       - name: Checkout Source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Dependencies (pip)
         run: |
-          pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r requirements-dev.txt
+          pip install -U -r requirements.txt -r tests/requirements.txt
       - name: Run Build Commands
-        run: python setup.py qtlrelease sample
+        run: |
+          python pkgutils.py qtlrelease
+          python pkgutils.py sample
       - name: Run Tests
         run: |
           export QT_QPA_PLATFORM=offscreen
-          pytest -v --cov=novelwriter --timeout=60
+          python -m pytest -v --cov=novelwriter --timeout=60
       - name: Upload to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/test_mac.yml

@@ -1,38 +1,37 @@
-name: macOS
+name: MacOS
 
 on:
   push:
-    branches: 
+    branches:
       - main
-      - patch
+      - release
   pull_request:
     branches:
       - main
-      - patch
+      - release
 
 jobs:
   testMac:
-    runs-on: macos-latest
+    runs-on: macos-13
     steps:
       - name: Python Setup
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
           architecture: x64
-      - name: Install Packages
+      - name: Install Packages (brew)
         run: |
           brew install enchant
       - name: Checkout Source
-        uses: actions/checkout@v3
-      - name: Install Dependencies
+        uses: actions/checkout@v4
+      - name: Install Dependencies (pip)
         run: |
-          pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r requirements-dev.txt
-          pip install pyobjc
+          pip install -U pyobjc -r requirements.txt -r tests/requirements.txt
       - name: Run Tests
         run: |
           export QT_QPA_PLATFORM=offscreen
-          pytest -v --cov=novelwriter --timeout=60
+          python -m pytest -v --cov=novelwriter --timeout=60
       - name: Upload to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/test_win.yml

@@ -2,32 +2,32 @@ name: Windows
 
 on:
   push:
-    branches: 
+    branches:
       - main
-      - patch
+      - release
   pull_request:
     branches:
       - main
-      - patch
+      - release
 
 jobs:
   testWin:
     runs-on: windows-latest
     steps:
       - name: Python Setup
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
           architecture: x64
       - name: Checkout Source
-        uses: actions/checkout@v3
-      - name: Install Dependencies
+        uses: actions/checkout@v4
+      - name: Install Dependencies (pip)
         run: |
-          pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install -r requirements-dev.txt
+          pip install -U -r requirements.txt -r tests/requirements.txt
       - name: Run Tests
         run: |
-          pytest -v --cov=novelwriter --timeout=60
+          python -m pytest -v --cov=novelwriter --timeout=60
       - name: Upload to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -9,6 +9,8 @@
 setup.iss
 /novelwriter.desktop
 /novelWriter.pyw
+/setup/macos/Info.plist
+.venv
 
 # Translations
 /novelwriter/assets/i18n/*.qm
@@ -32,7 +34,6 @@ __pycache__
 /novelwriter/assets/sample.zip
 /sample/cache
 /sample/meta
-/sample/versions
 *.bak
 *.lock
 ToC.txt
@@ -43,12 +44,12 @@ ToC.txt
 /tests/temp
 /tests/lipsum/cache
 /tests/lipsum/meta
-/tests/minimal/cache
-/tests/minimal/meta
-/tests/oldproj/cache
 /.pytest_cache
 /pytestdebug.log
 
 # Coverage
 /.coverage
 /coverage.*
+
+# Other
+/test.py

.readthedocs.yml

@@ -1,24 +0,0 @@
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/source/conf.py
-
-# Build documentation with MkDocs
-#mkdocs:
-#  configuration: mkdocs.yml
-
-# Optionally build your docs in additional formats such as PDF
-formats:
-  - htmlzip
-  - epub
-  - pdf
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-  install:
-    - requirements: docs/source/requirements.txt

CONTRIBUTING.md

@@ -1,45 +1,44 @@
 # Contributing Guide
 
-When contributing to this repository, please first discuss the change you wish to make via the
-issue tracker or the discussions page with the owner of this repository. Especially if it is
-regarding new features. If you just want to make a minor correction, like fix a typo or similar,
-feel free to just make a pull request directly.
+When contributing to this repository, please first discuss the change you wish to make with the
+owner. Either via the issue tracker or on the discussions page. Especially if it is regarding new
+features. If you just want to make a minor correction, like fix a typo or similar, feel free to
+just make a pull request directly.
 
-The following contributions are welcome:
+**The following contributions are welcome:**
 
 * Bugfixes for new or existing bugs. Please also report new bugs in the issue tracker even if you
   also provide a fix. It makes it easier to keep track of what has been fixed and when.
-* Translations via the [crowdin project page](https://crowdin.com/project/novelwriter).
+* Translations made via the [Crowdin project page](https://crowdin.com/project/novelwriter).
 * Improvements to the documentation. Particularly if the documentation is unclear. Please don't
   make any larger changes to the documentation without discussing if with the maintainer first.
 * Adaptations, installation or packaging features targeting specific operating systems.
 
-Please do not:
+**Please do not:**
 
-* Make a pull request that restructures or reformats existing code. If you think some parts of the
+* Make a pull request that restructures or reformats existing code. If you think some part of the
   code could be improved, please make an issue thread or start a discussion. The same applies to
   any text document in the repository.
 
-## Pull Requests
+## Picking the Correct Branch for a Pull Request
 
-This project follows the [OneFlow](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow)
-model. The `main` branch is the default branch. For general changes, please make a new branch in
-your own fork from the current `main` branch. Do not make pull requests from your own `main`
-branch.
+The `main` branch is the default branch. For general changes, please make a new branch in your own
+fork from the current `main` branch. Do not make pull requests from your copy of the `main` branch.
 
-**Note:** If your contribution is a bugfix for a specific version, please make a bugfix branch from
-the tag you want the fix to be applied to, not directly from the `main` branch. This is important.
+As of April 2024, releases are made from the `release` branch. If you are submitting a fix to a
+current release you must do so from the `release` branch. If you make such a fix on the `main`
+branch, **it cannot be included in a patch release**. This also applies to the documentation for
+the latest release published on the main website.
 
-Also check the following:
+**Also check the following:**
 
 * Make sure your code passes all tests and conforms to the style guide. You can check that the
   code generally conforms by running the Python linting tool `flake8` from the root of the project
-  folder, although it doesn't check everything. The same check is also run on pull requests by the
-  maintainer.
+  folder, although it doesn't check everything. The same check is also run on pull requests.
 * Please provide a description of the changes in the pull request under the summary section of the
   pull request template, and reference any related issues by providing the issue number.
 * Do not change the version number.
-* Do not submit files that were not actively changed but have otherwise been modifed. This is
+* Do not submit files that were not actively changed but have otherwise been modified. This is
   mostly an issue with translation files. The language tool may update all files in the `i18n`
   folder.
 
@@ -68,14 +67,14 @@ style guide, but with a few exceptions. Some key points are listed below.
   is the recommended line length in PEP8, but this is often too restrictive. 99 characters are
   acceptable when that is more practical. Readability has priority. Generally, if a code statement
   requires multiple lines, the lines should wrap at 79 characters if possible. If wrapping can be
-  avoided by going to 99, then that is generally preferrable.
+  avoided by going to 99, then that is generally preferable.
 * For text files, the text should be wrapped at 99 character. The exception is markdown image tags
   and urls which can run past that limit.
 
 **Variable and Function Names**
 
 * PEP8 allows for camelCase for consistency with existing code. The Qt library uses camelCase, so
-  the Python source code does too.
+  the novelWriter source code does too.
 * The exception to the above is for constants. They should always be in upper snake case, like PEP8
   states.
 
@@ -83,19 +82,29 @@ style guide, but with a few exceptions. Some key points are listed below.
 
 * Only indentation by multiples of 4 spaces is allowed.
 * No trailing spaces should occur on any line in the source code, including empty lines.
-* Ideally, a function should end on the same indention level as it started. Exceptions are allowed
-  if it makes the code easier to follow.
+* All common line wrapping methods are allowed in the code, but avoid deep indentations.
 * Aligning operators and attributes in columns with multiple spaces is not allowed by PEP8. The
   rule is relaxed a bit here. Alignment is allowed when populating large dictionaries or setting
   many class attributes. It does improve readability in such cases, but should not be overused.
 
+**Type Annotation**
+
+* All functions must be properly type annotated, and a return type stated in all cases.
+* Do not use `List`, `Dict`, `Tuple`, etc, annotations that were deprecated in Python 3.9. You can
+  install the `flake8-pep585` extension to make sure you don't forget. This is also checked by the
+  syntax action run on pull requests.
+* If annotations require a more recent Python version than the minimum version stated in the
+  project's `pyproject.toml`, hide it under an `if TYPE_CHECKING` condition so that the code can
+  still run on older versions. It's OK to require a more recent version for development.
+
 ### Linting with `flake8`
 
 A good tool for checking Python code for errors and code style is `flake8`. The documentation is
 available [here](https://flake8.pycqa.org/en/latest/).
 
-The `setup.cfg` file in the root of this project has the following settings for `flake8` that
-matches the above code style:
+The `.flake8` file in the root of this project has the following settings for that matches the
+required code style:
+
 ```conf
 [flake8]
 ignore = E133,E221,E226,E228,E241,W503
@@ -115,7 +124,7 @@ command will give you a detailed description of the code lines that do not confo
 Two of the ignored errors are due to the relaxed restriction on column alignment, these are the
 E221 and E241 error codes.
 
-The code E226 is ignored becuse it doesn't actually follow the
+The code E226 is ignored because it doesn't actually follow the
 [PEP8 recommendation](https://www.python.org/dev/peps/pep-0008/#other-recommendations)
 of grouping longer equations by operator precedence like `2*a + 3*b` instead of `a * a + 3 * b`.
 Generally, don't use spaces around `*`, `/` and `**`, but _do_ use spaces around `+` and `-`.

CREDITS.md

@@ -2,45 +2,75 @@
 
 ## Main Developer
 
-* Veronica Berglyd Olsen (@vkbo)
+* Veronica Berglyd Olsen
 
-## Main Contributors
+## Contributors
 
-* Concept: Marian Lückhof (@Number042)
-* Internationalisation: Bruno Meneguello (@bkmeneguello)
+* Early Concept: Marian Lückhof
+* Internationalisation: Bruno Meneguello
+* Setup and Packaging: Rachel Powers
+
+For other contributions, see the project's [Contributors](https://github.com/vkbo/novelWriter/graphs/contributors) page.
+
+## Artwork
+
+The artwork on the Welcome dialog was created by Louis Durrant.
 
 ## Translations
 
-The default language is English (UK) with English (US) as an option.
+The default language is English (UK) with English (US) as an option. These are the original
+translators for the languages currently available:
 
-* Dutch: Martijn van der Kleijn (@mvdkleijn)
-* French: Jan Lüdke (@jyhelle)
-* German: Myian (@heymyian)
-* Latin American Spanish: Tommy Marplatt (@tmarplatt)
-* Norwegian: Veronica Berglyd Olsen (@vkbo)
-* Portuguese: Bruno Meneguello (@bkmeneguello)
-* Simplified Chinese: Qianzhi Long (@longqzh)
+* **Dutch:** Martijn van der Kleijn (mvdkleijn)
+* **French:** Jan Lüdke (jyhelle)
+* **German:** Myian (HeyMyian)
+* **Italian:** Riccardo Mangili
+* **Japanese:** hebekeg
+* **Latin American Spanish:** Tommy Marplatt (tmarplatt)
+* **Norwegian:** Veronica Berglyd Olsen (vkbo)
+* **Polish:** Anna Maria Polak (Nauthiz)
+* **Portuguese:** Bruno Meneguello (bkmeneguello)
+* **Russian:** Konstantin Tan (k1kimosha)
+* **Simplified Chinese:** Qianzhi Long (longqzh)
+
+Additional larger translation contributions:
+
+* **French:** Albert Aribaud (aaribaud)
+* **Portuguese:** Oli Maia (olimaia)
+
+Translations are managed on [Crowdin](https://crowdin.com/project/novelwriter), and more
+contributions are listed on the project's Members page.
 
 ## Libraries
 
 The following libraries are dependencies of novelWriter:
 
-* Qt5 by [Qt Company](https://www.qt.io/)
-* PyQt5 by [Riverbank Computing](https://www.riverbankcomputing.com/software/pyqt/)
-* lxml by [Martijn Faassen](https://lxml.de/)
-* Enchant by [Dom Lachowicz](https://abiword.github.io/enchant/)
-* PyEnchant by [Dimitri Merejkowsky](https://pyenchant.github.io/pyenchant/)
+* **Qt5** by Qt Company
+* **PyQt5** by Riverbank Computing
+* **Enchant** by Dom Lachowicz
+* **PyEnchant** by Dimitri Merejkowsky
 
 ## Assets
 
 Some of the assets bundled with novelWriter were adapted from the following sources:
 
-* Typicons icons by [Stephen Hutchings](https://github.com/stephenhutchings/typicons.font) (CC BY-SA 4.0)
-* Tomorrow syntax themes by Chris Kempson (MIT License)
-* Owl syntax themes by Sarah Drasner (MIT License)
-* Solarized themes by Ethan Schoonover, added by @nullbasis (MIT License)
+* **Typicons** icons by Stephen Hutchings (CC BY-SA 4.0)
+* **Tomorrow** syntax themes by Chris Kempson (MIT License)
+* **Owl** syntax themes by Sarah Drasner (MIT License)
+* **Solarized** themes by Ethan Schoonover (MIT License)
+* **Cyberpunk Night** theme by Anders Lemvigh (CC BY-SA 4.0)
+* **Dracula** theme by Zeno Rocha (MIT License)
+* **Snazzy Light** theme by Florian Reuschel (MIT License)
+
+## Fonts
+
+The font used for the main novelWriter logo, mimetype and text banners is Pridi. Other fonts are
+used on buttons and icons.
+
+* **Pridi** by Cadson Demak (Open Font License, Version 1.1)
+* **Source Sans Pro** by Paul D. Hunt (SIL Open Font License)
 
 ## Special Mentions
 
-Additional thanks to @johnblommers who was an early user and who has provided a lot of very useful
+Additional thanks to John Blommers who was an early user and who has provided a lot of very useful
 feedback over the years.

MANIFEST.in

@@ -1,7 +1,6 @@
-include setup.py
+include pkgutils.py
 include LICENSE.md
 include CREDITS.md
 include CHANGELOG.md
-recursive-include setup *
 recursive-include novelwriter/assets *
-recursive-include sample *.nwx *.nwd
+recursive-include setup *

README.md

@@ -2,16 +2,11 @@
 
 [![Linux](https://github.com/vkbo/novelWriter/actions/workflows/test_linux.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_linux.yml)
 [![Windows](https://github.com/vkbo/novelWriter/actions/workflows/test_win.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_win.yml)
-[![macOS](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml)
-[![flake8](https://github.com/vkbo/novelWriter/workflows/flake8/badge.svg)](https://github.com/vkbo/novelWriter/actions)
-[![codecov](https://codecov.io/gh/vkbo/novelWriter/branch/main/graph/badge.svg)](https://codecov.io/gh/vkbo/novelWriter)
-[![docs](https://readthedocs.org/projects/novelwriter/badge/?version=latest)](https://novelwriter.readthedocs.io/en/latest/?badge=latest)  
-[![release](https://img.shields.io/github/v/release/vkbo/novelwriter)](https://github.com/vkbo/novelWriter/releases)
-[![pypi](https://img.shields.io/pypi/v/novelwriter)](https://pypi.org/project/novelWriter)
-[![python](https://img.shields.io/pypi/pyversions/novelwriter)](https://pypi.org/project/novelWriter)
-[![Crowdin](https://badges.crowdin.net/novelwriter/localized.svg)](https://crowdin.com/project/novelwriter)
+[![MacOS](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml)
+[![Flake8](https://github.com/vkbo/novelWriter/workflows/flake8/badge.svg)](https://github.com/vkbo/novelWriter/actions)
+[![CodeCov](https://codecov.io/gh/vkbo/novelWriter/branch/main/graph/badge.svg)](https://codecov.io/gh/vkbo/novelWriter)
 
-<img align="left" style="margin: 0 16px 4px 0;" src="https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/novelwriter.png">
+<img align="left" style="margin: 0 0 4px 0;" src="https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/novelwriter_readme.png">
 
 novelWriter is a plain text editor designed for writing novels assembled from many smaller text
 documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta data syntax
@@ -23,43 +18,31 @@ synchronisation tools. All text is saved as plain text files with a meta data he
 project structure is stored in a single project XML file. Other meta data is primarily saved as
 JSON files.
 
-The full documentation is available at
-[novelwriter.readthedocs.io](https://novelwriter.readthedocs.io).
+For more details, and how to install and use novelWriter, please see the main website and
+documentation.
 
-The full credits are listed in
-[CREDITS.md](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md).
+**Project Links**
 
-You can also follow novelWriter on Mastodon at [fosstodon.org/@novelwriter](https://fosstodon.org/@novelwriter).
+* Website: [novelwriter.io](https://novelwriter.io)
+* Documentation: [docs.novelwriter.io](https://docs.novelwriter.io)
+* Internationalisation: [crowdin.com/project/novelwriter](https://crowdin.com/project/novelwriter)
+* PyPi Project: [pypi.org/project/novelWriter](https://pypi.org/project/novelWriter)
+* Social Media: [fosstodon.org/@novelwriter](https://fosstodon.org/@novelwriter)
+
+## Sponsors
+
+<table style="border: none;">
+<tr>
+  <td><img align="left" style="height: 25px;" src="https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/signpath_logo.png"></td>
+  <td>Free code signing on Windows provided by <a href="https://about.signpath.io/">SignPath.io</a>, certificate by <a href="https://signpath.org/">SignPath Foundation</a>.</td>
+</tr>
+</table>
 
 ## Implementation
 
-The application is written with Python 3 (3.7+) using Qt5 and PyQt5 (5.10+). It is developed on
-Linux, but should in principle work fine on other operating systems as well as long as dependencies
-are met. It is regularly tested on Debian and Ubuntu Linux, Windows, and macOS.
-
-## Installation
-
-### Linux Mint, Ubuntu and Debian
-
-The Releases page has a `.deb` package that should install on Mint, Ubuntu and Debian.
-
-You can also use the novelWriter [PPA](https://launchpad.net/~vkbo/+archive/ubuntu/novelwriter).
-For more details, check the [Getting Started](https://novelwriter.readthedocs.io/en/latest/int_started.html)
-section in the documentation.
-
-### Windows 10+
-
-The Release page has a `setup.exe` file for Windows 10, that should also work on other Windows
-versions. The installer includes Python 3.10 and the library dependencies.
-
-### Other Install Options
-
-You can also download and install one of the minimal zip files from the
-[Releases](https://github.com/vkbo/novelWriter/releases) page or the
-[novelwriter.io](https://novelwriter.io/) website.
-The [Getting Started](https://novelwriter.readthedocs.io/en/latest/int_started.html) section of the
-documentation has detailed install instructions for these packages, and for installation via the
-Python Package Index.
+novelWriter is written with Python 3 (3.9+) using Qt5 and PyQt5 (5.15 only), and is released on
+Linux, Windows and macOS. It can in principle run on any Operating System that also supports Qt,
+PyQt and Python.
 
 ## Project Contributions
 
@@ -73,6 +56,12 @@ also be appreciated, but please make an issue or a discussion topic first. Befor
 code, please also read the full
 [Contributing Guide](https://github.com/vkbo/novelWriter/blob/main/CONTRIBUTING.md).
 
+Project credits are available in [CREDITS.md](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md).
+
+**Note:** As of April 2024 only pre-releases are made from the `main` branch. Full releases are
+made from the `release` branch. So if you're submitting a fix to a current release, **including
+changes to documentation**, they must be made to the `release` branch.
+
 ### Translations
 
 New translations are always welcome. This project uses Crowdin to maintain translations, and you
@@ -83,112 +72,10 @@ If you have any questions, feel free to post them to the
 For more details, and how to use Qt Linguist for translations, see the
 [i18n instructions](https://github.com/vkbo/novelWriter/blob/main/i18n/README.md).
 
-## Key Features
-
-Some key features of novelWriter are listed below. The
-[documentation](https://novelwriter.readthedocs.io) has a lot more information.
-
-### Formatting Codes
-
-Although novelWriter is a plain text editor, it uses a Markdown-like syntax to allow for a minimal
-set of formatting that is useful for the specific task of writing novels.
-
-| Code       | Usage    | Description |
-|------------|----------|-------------|
-| `#`        | Prefix   | Headings level 1 to 4. |
-| `_`        | Wrapped  | Emphasised (italicised) text. |
-| `**`       | Wrapped  | Strongly emphasised (bold) text. |
-| `~~`       | Wrapped  | Strikethrough text. |
-| `%`        | Prefix   | A comment; does not count towards the word count.<sup>1</sup> |
-| `@`        | Prefix   | The following text is parsed as a keyword/value command for meta data. |
-| `>`        | Prefix   | The paragraph is indented one tab width from the left. |
-| `<`        | Suffix   | The paragraph is indented one tab width from the right. |
-| `>>`       | Prefix   | The paragraph is right-aligned. |
-| `<<`       | Suffix   | The paragraph is left-aligned. |
-| `>>`, `<<` | Wrapped  | The paragraph is centred. |
-
-<sup>1</sup> If the first word of the comment is `synopsis:`, the comment is indexed and treated as
-the synopsis for the section of text where it occurs. These synopsis comments can be used to build
-an outline and exported to external documents.
-
-### Export Formats
-
-The core export formats of novelWriter are Open Document and HTML5. Open Document is an open
-standard for office type documents that is supported by most office applications. See
-[Open Document > Application Support](https://en.wikipedia.org/wiki/OpenDocument#Application_support)
-for more details.
-
-You can also export the entire project as a single novelWriter-markup document. These can later be
-imported again into novelWriter. In addition, printing and export to PDF is offered through the Qt
-library, although with limitations to formatting.
-
-### Colour Themes
-
-The editor has syntax highlighting for the features it supports, and includes a set of different
-syntax highlighting themes. Optional GUI themes are also available, including dark themes.
-
-### Easy Organising of Project Files
-
-The structure of the project is shown on the left hand side of the main window. Project files are
-organised into root folders, indicating what class of file they are. The most important root folder
-is the `Novel` folder, which contains all of the files that make up the novel itself. Each root
-folder can have subfolders. Subfolders have no impact on the final project structure, they are
-there for you to organise your files in whatever way you want.
-
-The editor supports four levels of headings, which determine what level the following text belongs
-to. Headings of level one signify a book or partition title. Headings of level two signify the
-start of a new chapter. Headings of level three signify the start of a new scene. Headings of level
-four can be used internally in each scene to create separate sections.
-
-See the [documentation](https://novelwriter.readthedocs.io) for further details.
-
-### Project Notes
-
-Supporting notes can be added for the story plot, characters, locations, story timeline, etc. These
-have their separate root folders and are optional to use.
-
-### Visualisation of Story Elements
-
-The different notes can be assigned tags, which other files can refer back to using `@`-prefixed
-meta keywords. This information can be used to display an outline of the story, showing where each
-scene connects to the plot, and which characters, etc. occur in them. In addition, the tags
-themselves are clickable in the document view pane, and control-clickable in the editor. They make
-it possible to quickly navigate between the documents while writing.
-
-## Installing or Running from Source
-
-If you want to run novelWriter directly from the source code, you must run the `novelWriter.py`
-file from command line.
-
-Dependencies can generally be installed from PyPi with:
-```bash
-pip install -r requirements.txt
-```
-
-On Linux, the dependencies are generally available in the standard package repository.
-
-For more details on running or installing from source, see
-[Other Setup Methods](https://novelwriter.readthedocs.io/en/latest/setup_other.html).
-
-## Debugging
-
-If you need to debug novelWriter, you must run it from the command line. It takes a few parameters,
-which can be listed with the switch `--help`. The `--info`, `--debug` or `--verbose` flags are
-particularly useful for increasing logging output for debugging.
-
 ## Licence
 
 This is Open Source software, and novelWriter is licenced under GPLv3. See the
 [GNU General Public License website](https://www.gnu.org/licenses/gpl-3.0.en.html) for more
-details, or consult the [LICENSE](https://github.com/vkbo/novelWriter/blob/main/LICENSE.md) file.
-
-Bundled assets and their licences are listed in
-[CREDITS](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md).
-
-## Screenshots
-
-**novelWriter with default system theme:**
-![Screenshot 1](https://raw.githubusercontent.com/vkbo/novelWriter/main/docs/source/images/screenshot_default.png)
-
-**novelWriter with dark theme:**
-![Screenshot 2](https://raw.githubusercontent.com/vkbo/novelWriter/main/docs/source/images/screenshot_dark.png)
+details, or consult the [License](https://github.com/vkbo/novelWriter/blob/main/LICENSE.md)
+document. Bundled assets and their licences are listed in the
+[Credits](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md) document.

docs/source/_static/custom.css

@@ -0,0 +1,14 @@
+span.guilabel {
+    font-weight: 400;
+}
+
+.nw-sidebar-title {
+    height: unset;
+    max-height: unset;
+    flex-direction: column;
+    justify-content: center;
+    gap: .25rem;
+    font-size: 1.25rem;
+    font-weight: normal;
+    text-align: center;
+}

docs/source/_templates/sidebar-title.html

@@ -0,0 +1,3 @@
+{% if docstitle %}
+<p class="nw-sidebar-title">{{ docstitle }}</p>
+{% endif %}

docs/source/conf.py

@@ -1,10 +1,7 @@
-#
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
-#
+"""
+Configuration file for the Sphinx documentation builder.
+Documentation: http://www.sphinx-doc.org/en/master/config
+"""
 
 # -- Imports -----------------------------------------------------------------
 
@@ -15,7 +12,7 @@ import datetime
 # -- Project Information -----------------------------------------------------
 
 project = "novelWriter"
-copyright = f"{datetime.date.today().year}, Veronica Berglyd Olsen"
+copyright = f"{datetime.date.today().year}"
 author = "Veronica Berglyd Olsen"
 
 initFile = os.path.join(
@@ -30,37 +27,45 @@ with open(initFile) as inFile:
     else:
         release = "unknown"
 
-version = release.split("-")[0]
+version = release.partition("-")[0]
 
 # -- General Configuration ---------------------------------------------------
 
 os.environ["TZ"] = "Europe/Oslo"
 time.tzset()
 
-needs_sphinx = "4.0"
+needs_sphinx = "5.0"
+extensions = ["sphinx_design"]
 templates_path = ["_templates"]
 source_suffix = ".rst"
 master_doc = "index"
 today_fmt = "%A, %d %B %Y at %H:%M"
 language = "en"
 exclude_patterns = []
-pygments_style = "sphinx"
-pygments_dark_style = "monokai"
 
 # -- Options for HTML Output -------------------------------------------------
 
-html_theme = "furo"
+html_theme = "sphinx_book_theme"
+html_title = f"Version {release}"
 html_static_path = ["_static"]
+html_css_files = ["custom.css"]
 html_theme_options = {
-    "light_logo": "novelwriter-light.png",
-    "dark_logo": "novelwriter-dark.png",
+    "logo": {
+        "image_light": "_static/novelwriter-light.png",
+        "image_dark": "_static/novelwriter-dark.png",
+    },
+    "show_toc_level": 2,
+    "show_navbar_depth": 1,
+    "repository_url": "https://github.com/vkbo/novelwriter",
+    "navigation_with_keys": True,
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "pygment_light_style": "tango",
+    "pygment_dark_style": "dracula",
+}
+html_sidebars = {
+    "**": ["navbar-logo", "sidebar-title", "sbt-sidebar-nav"],
 }
-html_title = f"<div style='text-align: center'>Documentation Version {release}</div>"
-
-# -- Options for HTMLHelp Output ---------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "novelWriterDoc"
 
 # -- Options for LaTeX Output ------------------------------------------------
 
@@ -73,44 +78,7 @@ latex_elements = {
     ),
     "figure_align": "htbp",
 }
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
+latex_logo = "_static/novelwriter-pdf.png"
 latex_documents = [(
-    master_doc, "manual.tex", "novelWriter Documentation",
-    author, "manual"
+    master_doc, "manual.tex", "User Guide", author, "manual"
 )]
-
-# -- Options for Man Page Output ---------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [(
-    master_doc, "novelwriter", "novelWriter Documentation", [author], 1
-)]
-
-# -- Options for Texinfo Output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [(
-    master_doc, "novelWriter", "novelWriter Documentation", author,
-    "novelWriter", "Markdown-like editor for novels.", "Miscellaneous"
-)]
-
-# -- Options for EPub Output -------------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-# epub_identifier = ""
-
-# A unique identification for the text.
-# epub_uid = ""
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ["search.html"]

docs/source/index.rst

@@ -1,44 +1,34 @@
-#############################
-Documentation for novelWriter
-#############################
+######################
+novelWriter User Guide
+######################
 
-.. image:: images/novelwriter_logo.png
-   :align: right
-   :width: 48
+| **Release Version:** |release|
+| **Updated:** |today|
 
-| **For Release:** |release|
-| **Last Updated:** |today|
-|
-
-novelWriter is an open source plain text editor designed for writing novels assembled from many
-smaller text documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta
-data syntax for comments, synopsis, and cross-referencing. It is designed to be a simple text
+novelWriter is an open source plain text editor designed for writing novels assembled from
+individual text documents. It uses a minimal formatting syntax inspired by Markdown, and adds a
+meta data syntax for comments, synopsis, and cross-referencing. It is designed to be a simple text
 editor that allows for easy organisation of text and notes, using human readable text files as
 storage for robustness.
 
 .. figure:: images/screenshot_multi.png
+   :class: dark-light
    :align: center
    :width: 500
 
 The project storage is suitable for version control software, and also well suited for file
-synchronisation tools. All text is saved as plain text files with a meta data header. The core
-project structure is stored in a single project XML file. Other meta data is primarily saved as
-JSON files. See the :ref:`a_breakdown_storage` section for more details.
+synchronisation tools. All text is saved as plain text files, and your project data as standard
+data formats in XML and JSON. See :ref:`a_storage` for more details.
 
-Any operating system that can run Python 3 and has the Qt 5 libraries should be able to run
-novelWriter. It runs fine on Linux, Windows and macOS, and users have tested it on other platforms
-as well. novelWriter can also be run directly from the Python source, or installed from packages or
-the pip tool. See :ref:`a_started` for more details.
-
-.. note::
-   Version 1.5 introduced a few changes that will require you to make some minor modifications to
-   some of the headings in your project. It should be fairly quick and straightforward. Please see
-   the :ref:`a_prjfmt_1_3` section for more details.
+Any operating system that has Python 3 and the Qt 5 libraries should be able to run novelWriter.
+It runs fine on Linux, Windows and MacOS, and users have tested it on other platforms as well.
+See :ref:`a_started` for more details.
 
 **Useful Links**
 
 * Website: https://novelwriter.io
-* Documentation: https://novelwriter.readthedocs.io
+* Documentation: https://docs.novelwriter.io
+* Public Releases: https://releases.novelwriter.io
 * Internationalisation: https://crowdin.com/project/novelwriter
 * Source Code: https://github.com/vkbo/novelWriter
 * Source Releases: https://github.com/vkbo/novelWriter/releases
@@ -47,6 +37,11 @@ the pip tool. See :ref:`a_started` for more details.
 * PyPi Project: https://pypi.org/project/novelWriter
 * Social Media: https://fosstodon.org/@novelwriter
 
+.. toctree::
+   :hidden:
+
+   Main Page <self>
+
 .. toctree::
    :maxdepth: 1
    :caption: Introduction
@@ -55,8 +50,8 @@ the pip tool. See :ref:`a_started` for more details.
    int_introduction
    int_overview
    int_started
-   int_source
-   int_customise
+   int_howto
+   int_glossary
 
 .. toctree::
    :maxdepth: 1
@@ -64,11 +59,11 @@ the pip tool. See :ref:`a_started` for more details.
    :hidden:
 
    usage_breakdown
-   usage_interface
+   usage_project
+   usage_writing
    usage_format
    usage_shortcuts
    usage_typography
-   usage_projectformat
 
 .. toctree::
    :maxdepth: 1
@@ -77,14 +72,24 @@ the pip tool. See :ref:`a_started` for more details.
 
    project_overview
    project_structure
-   project_notes
-   project_export
+   project_references
+   project_manuscript
 
 .. toctree::
    :maxdepth: 1
-   :caption: Under the Hood
+   :caption: Additional Details
+   :hidden:
+
+   more_customise
+   more_projectformat
+   more_counting
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Technical Topics
    :hidden:
 
    tech_locations
    tech_storage
+   tech_source
    tech_tests

docs/source/int_customise.rst

@@ -1,65 +0,0 @@
-.. _a_custom:
-
-**************
-Customisations
-**************
-
-.. _Enchant: https://abiword.github.io/enchant
-.. _Free Desktop: https://cgit.freedesktop.org/libreoffice/dictionaries/tree/
-
-There are a few ways you can customise novelWriter youself. Currently, you can add new GUI themes,
-your own syntax themes, and install additional dictionaries.
-
-
-.. _a_custom_dict:
-
-Spell Check Dictionaries
-========================
-
-novelWriter uses Enchant_ as the spell checking tool. Depending on you operating system, it may or
-may not load installed spell check dictionaries.
-
-Linux
-   On Linux, you generally only have to install hunspell or aspell dictionaries on your system like
-   you do for other applications. See your distro's documentation for how to do this. These
-   dictionaries should then show up as available spell check languages in novelWriter.
-
-Windows
-   For Windows, English is included with the installation. For other languages you have to download
-   and add dictionaries yourself. You can find the various dictionaries on the `Free Desktop`_
-   website. You should find a folder for your language, if it is available at all, and download the
-   files ending with ``.aff`` and ``.dic``. These files must then be copied to the following
-   location:
-
-   ``C:\Users\<USER>\AppData\Local\enchant\hunspell``
-
-   This assumes your user profile is stored at ``C:\Users\<USER>``. The last one or two folders may
-   not exist, so you may need to create them.
-
-
-.. _a_custom_theme:
-
-Syntax and GUI Themes
-=====================
-
-Adding your own GUI and syntax themes is relatively easy. The themes are defined by simple plain
-text config files with meta data and colour settings.
-
-In order to make your own versions, first copy one of the existing files to your local computer and
-modify it as you like.
-
-* The existing syntax themes are stored in
-  `novelwriter/assets/syntax <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/syntax>`_.
-* The existing GUI themes are stored in
-  `novelwriter/assets/themes <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/themes>`_.
-
-Remember to also change the name of your theme by modifying the ``name`` setting at the top of the
-file, otherwise you may not be able to distinguish them in :guilabel:`Preferences`.
-
-For novelWriter to be able to locate the custom theme files, you must copy them to the
-:ref:`a_locations_data` location in your home or user area. There should be a folder there named
-``syntax`` for syntax themes and just ``themes`` for GUI themes. These folders are created the
-first time you start novelWriter.
-
-Once the files are copied there, they should show up in :guilabel:`Preferences` with the label you
-set as ``name`` inside the file.

docs/source/int_glossary.rst

@@ -0,0 +1,64 @@
+.. _a_glossary:
+
+********
+Glossary
+********
+
+.. glossary::
+   :sorted:
+
+   Root Folder
+      A "Root Folder" is a top level folder of the project tree in novelWriter. Each type of root
+      folder has a specific icon to identify it. For an overview of available root folder types,
+      see :ref:`a_proj_roots`.
+
+   Novel Documents
+      These are documents that are created under a "Novel" :term:`Root Folder`. They behave
+      differently than :term:`Project Notes`, and have some more restrictions. For instance, they
+      can not exist in folders intended only for project notes. See the :ref:`a_struct` chapter for
+      more details.
+
+   Project Notes
+      Project Notes are unrestricted documents that can be placed anywhere in your project. You
+      should not use these documents for story elements, only for notes. Project notes are the
+      source files used by the Tags and References system. See the :ref:`a_references` chapter for
+      more details on how to use them.
+
+   Tag
+      A tag is a user defined value assigned as a tag to a section of your :term:`Project Notes`.
+      It is optional, and can be defined once per heading. It is set using the :term:`keyword`
+      syntax ``@tag: value``, where ``value`` is the user defined part. Each tag can be referenced
+      in another file using one of the :term:`reference` keywords. See :ref:`a_references` chapter
+      for more details.
+
+   Reference
+      A reference is one of a set of :term:`keywords<keyword>` that can be used to link to a
+      :term:`tag` in another document. The reference keywords are specific to the different
+      :term:`root folder` types. A full overview is available in the :ref:`a_references` chapter.
+
+   Project Index
+      The project index is a record of all headings in a project, with all their meta data like
+      synopsis comments, :term:`tags<tag>` and :term:`references<reference>`. The project index is
+      kept up to date automatically, but can also be regenerated manually from the
+      :guilabel:`Tools` menu or by pressing :kbd:`F9`.
+
+   Context Menu
+      A context menu is a menu that pops up when you right click something in the user interface.
+      In novelWriter, you can often also open a context menu by pressing the keyboard shortcut
+      :kbd:`Ctrl+.`.
+
+   Headings
+      Each level of headings in :term:`Novel Documents` have a specific meaning in terms of the
+      structure of the story. That is, they determine what novelWriter considers a partition, a
+      chapter, a scene or a text section. For :term:`Project Notes`, the heading levels don't
+      matter. For more details on headings in novel documents, see :ref:`a_struct_heads`.
+
+   Keyword
+      A keyword in novelWriter is a special command you put in the text of your documents. They are
+      not standard Markdown, but are used in novelWriter to add information that is interpreted by
+      the application. For instance, keywords are used for :term:`tags<tag>` and
+      :term:`references<reference>`.
+
+      Keywords must always be on their own line, and the first character of the line must always be
+      the ``@`` character. The keyword must also always be followed by a ``:`` character, and the
+      values passed to the command are added after this, separated by commas.

docs/source/int_howto.rst

@@ -0,0 +1,119 @@
+.. _a_howto:
+
+*************
+Tips & Tricks
+*************
+
+.. _Discussions Page: https://github.com/vkbo/novelWriter/discussions
+
+This is a list of hopefully helpful little tips on how to get the most out of novelWriter.
+
+.. note::
+   This section will be expanded over time. If you would like to have something added, feel free to
+   contribute, or start a discussion on the project's `Discussions Page`_.
+
+
+Managing the Project
+====================
+
+.. dropdown:: How do I create a project from a template?
+   :animate: fade-in-slide-down
+
+   On the Welcome dialog's **Create New Project** form, you can select to "Prefill Project" from
+   the content of a different project. This feature is most useful if you copy a project you have
+   dedicated to be a template project. If you have a structure and settings you want to use for
+   every new project, this is the best solution.
+
+.. dropdown:: How do I merge multiple documents into one?
+   :animate: fade-in-slide-down
+
+   If you need to merge a selection of documents in your project into a single document, you can
+   achieve this by first making a new folder for just that purpose, and drag all the documents you
+   want merged into this folder. Then you can right click the folder, select :guilabel:`Transform`
+   and :guilabel:`Merge Documents in Folder`.
+
+   In the dialog that pops up, the documents will be in the same order as in the folder, but you
+   can rearrange them here of you wish. See :ref:`a_ui_tree_split_merge` for more details.
+
+.. dropdown:: How do I share status or importance labels between projects?
+   :animate: fade-in-slide-down
+
+   The status or importance labels you have defined in a project can be exported from **Project
+   Settings** from the respective configuration tabs. You can then import these labels in another
+   project.
+
+
+Layout Tricks
+=============
+
+.. dropdown:: How do I create a table?
+   :animate: fade-in-slide-down
+
+   The formatting tools available in novelWriter don't allow for complex structures like tables.
+   However, the editor does render tabs in a similar way that regular word processors do. You can
+   set the width of a tab in **Preferences**.
+
+   The tab key should have the same distance in the editor as in the viewer, so you can align text
+   in columns using the tab key, and it should look the same when viewed next to the editor.
+
+   This is most suitable for your notes, as the result in exported documents cannot be guaranteed
+   to match. Especially if you don't use the same font in your manuscript as in the editor.
+
+.. dropdown:: How do I force a line break when line breaks are ignored in my manuscript?
+   :animate: fade-in-slide-down
+
+   In the **Manuscript Build Settings** you can choose to ignore line breaks within paragraphs in
+   your text. However, some times you still need those breaks. Like for instance on the cover page
+   where you may need to add your name and address. In such cases, you can add ``[br]`` where you
+   want line breaks. These breaks cannot be ignored by any settings and will always be respected.
+
+   .. versionadded:: 2.6
+
+.. dropdown:: How do I turn off first line indent for a specific paragraph?
+   :animate: fade-in-slide-down
+
+   If you have first line indent enabled, but have a specific paragraph that you don't want
+   indented, you can disable the indentation by explicitly adding text alignment. For instance by
+   adding ``<<`` to the end to left-align it. Aligned paragraphs are not indented.
+
+   See :ref:`a_fmt_align` for more details.
+
+
+Organising Your Text
+====================
+
+.. dropdown:: How do I add introductory text to chapters?
+   :animate: fade-in-slide-down
+
+   Sometimes chapters have a short preface, like a brief piece of text or a quote to set the stage
+   before the first scene begins.
+
+   If you add separate files for chapters and scenes, the chapter file is the perfect place to add
+   such text. Separating chapter and scene files also allows you to make scene files child
+   documents of the chapter.
+
+.. dropdown:: How do I distinguishing between soft and hard scene breaks?
+   :animate: fade-in-slide-down
+
+   Depending on your writing style, you may need to separate between soft and hard scene breaks
+   within chapters. Like for instance if you switch point-of-view character often.
+
+   In such cases you may want to use different scene headings for hard and soft scene breaks. The
+   **Build Manuscript** tool will let you define a different format for scenes using the ``###``
+   and ``###!`` heading codes when you generate your manuscript. You can for instance add the
+   common "``* * *``" for hard breaks and select to hide soft scene breaks, which will just insert
+   an empty paragraph in their place. See :ref:`a_manuscript_settings` for more details.
+
+   .. versionadded:: 2.4
+
+
+Other Tools
+===========
+
+.. dropdown:: How do I convert my project to/from the yWriter format?
+   :animate: fade-in-slide-down
+
+   There is a tool available that lets you convert a `yWriter <http://spacejock.com/yWriter7.html>`_
+   project to a novelWriter project, and vice versa.
+
+   The tool is available at `peter88213.github.io/yw2nw <https://peter88213.github.io/yw2nw/>`__

docs/source/int_introduction.rst

@@ -1,66 +1,116 @@
 .. _a_intro:
 
-************
+********
+Overview
+********
+
+.. _Snowflake: https://www.advancedfictionwriting.com/articles/snowflake-method/
+.. _Markdown: https://en.wikipedia.org/wiki/Markdown
+
+At its core, novelWriter is a multi-document plain text editor. The idea is to let you edit your
+text without having to deal with formatting until you generate a draft document or manuscript.
+Instead, you can focus on the writing right from the start.
+
+Of course, you probably need *some* formatting for your text. At the very least you need emphasis.
+Most people are familiar with adding emphasis using ``_underscores_`` and ``**asterisks**``. This
+formatting standard comes from Markdown_ and is supported by novelWriter. It also uses Markdown
+formatting for defining document headings. If you need more specialised formatting, additional
+formatting options are available using a shortcode format. See :ref:`a_fmt_shortcodes` for more
+details.
+
+.. admonition:: Limitations
+
+   novelWriter is designed for writing fiction, so the formatting features available are limited to
+   those relevant for this purpose. It is *not* suitable for technical writing, and it is *not* a
+   full-featured Markdown editor.
+
+   It is also not intended as a tool for organising research for writing, and therefore lacks
+   formatting features you may need for this purpose. The notes feature in novelWriter is mainly
+   intended for character profiles and plot outlines.
+
+Your novel project in novelWriter is organised as a collection of separate plain text documents
+instead of a single, large document. The idea is to make it easier to reorganise your project
+structure without having to cut and paste text between chapters and scenes.
+
+There are two kinds of documents in your project: :term:`Novel Documents` are documents that are
+part of your story. The other kind of documents are :term:`Project Notes`, which are intended for
+your notes about your characters, your world building, and so on.
+
+You can at any point split the individual documents by their headings up into multiple documents,
+or merge multiple documents into a single document. This makes it easier to use variations of the
+Snowflake_ method for writing. You can start by writing larger structure-focused documents, like
+for instance one document per act, and later effortlessly split these up into individual chapter or
+scene documents.
+
+
+.. _a_intro_features:
+
 Key Features
-************
-
-.. _Snowflake : https://www.advancedfictionwriting.com/articles/snowflake-method/
-
-At the core, novelWriter is a multi-document plain text editor. It uses a markup syntax inspired by
-Markdown to apply simple formatting to the text. It is designed for writing fiction, so the
-formatting features are limited to those relevant for this purpose. It is not suitable for
-technical writing.
-
-Your novel project is organised as a collection of separate plain text documents instead of a
-single, large document. The idea here is to make it easier to reorganise your project structure
-without having to cut and paste text.
-
-You can at any point split documents by their header, or merge multiple documents into single
-documents. This makes it easier to use variations of the popular Snowflake_ method for writing.
+============
 
 Below are some key features of novelWriter.
 
 **Focus on writing**
-   The aim of the user interface is to let the user focus on writing instead of spending time
-   formatting text. Formatting is therefore limited to a small set of formatting tags for simple
-   things like text emphasis and paragraph alignment. When you really want to focus on just
-   writing, you can switch the editor into :guilabel:`Focus Mode` where only the text editor window
-   itself is vissible.
+   The aim of the user interface is to let you focus on writing instead of spending time formatting
+   text. Formatting is therefore limited to a small set of formatting tags for simple things like
+   text emphasis and paragraph alignment. Additional shortcodes are available for special
+   formatting cases when you need them.
+
+   When you really want to focus on just writing, you can switch the editor into **Focus Mode**
+   where only the text editor panel itself is visible, and the project structure view is hidden
+   away.
 
 **Keep an eye on your notes**
-   The main window can optionally show a document viewer to the right of the editor. This view
-   panel is intended for displaying another scene document, you character notes, plot notes, or any
-   other document you may need to reference while writing.
+   The main window can optionally show a document viewer to the right of the editor. The viewer
+   is intended for displaying another scene document, your character notes, plot notes, or any
+   other document you may need to reference while writing. It is not intended as a preview panel
+   for the document you're editing, but if you wish, you can also use it for this purpose.
 
 **Organise your documents how you like**
    You can split your novel project up into as many individual documents as you want to. When you
-   build the project, they are all glued together in the top-to-bottom order in which they appear
-   in the project tree. You can use as few text documents as you like, but splitting the project up
-   into chapters and scenes means you can easily reorder them using the drag and drop feature. You
-   can start out with a few documents and then later split the document into multiple documents
-   based on its headers.
+   build the project into a manuscript, they are all glued together in the top-to-bottom order in
+   which they appear in the project tree. You can use as few text documents as you like, but
+   splitting the project up into chapters and scenes means you can easily reorder them using the
+   drag-and-drop feature of the project tree. You can also start out with fewer documents and then
+   later split them into multiple documents based on chapter and scene headings.
 
-**Keep track of your plot elements**
-   All notes in your project can be assigned a *tag* you can *reference* from any other document or
-   note. In fact, you can add a new tag under each heading of a note if you need to be able to
-   reference a specific section. Note tags are organised into categories with specific reference
-   keywords.
+**Multi-novel project support**
+   The main parts of your project is split up into top level special folders called "Root" folders.
+   Your main story text lives in the "Novel" root folder. You can have multiple such folders in a
+   project, and rename them to whatever you want. This allows you to keep a series of individual
+   novels with the same characters and world building in the same project, and create manuscripts
+   for them separately.
 
-**Get an overview of your plot elements**
-   In the :guilabel:`Outline View` on the main window you can see an outline of all the chapters,
-   scenes, and sections of your project. If they have any references in them, these are listed in
-   additional columns. You can also add a synopsis to each document, which can be listed here as
-   well. You have the option to add or remove columns of information from this outline. A subset of
-   the outline information is also available in the :guilabel:`Novel View` as a replacement for the
-   main project tree.
+**Keep track of your story elements**
+   All documents in your project can be assigned a :term:`tag` that you can then :term:`reference`
+   from any other document or note. In fact, you can add a new tag under each heading of a note if
+   you need to be able to reference specific sections of it, or you want to keep several topics or
+   scenes in the same document.
 
-**Building your manuscript**
-   Whether you want to compile a manuscript, or export all your notes, or generate an outline of
-   your chapters and scenes with a synopsis, you can use the :guilabel:`Build Novel Project` tool.
-   The tool lets you select what information you want to include in the generated document, and how
-   it is formatted. You can send the result to a printer, a PDF, or to an Open Document file that
-   can be opened by most office type word processors. You can also generate the result as HTML, or
-   Markdown, both suitable for further conversion to other formats.
+**Get an overview of your story**
+   It is not the documents themselves that define the chapters and scenes of your story, but the
+   headings within them. In the **Outline View** on the main window you can see an outline of all
+   the chapter and scene headings of each novel root folder in your project. If they have any
+   references in them, like which character is in what chapter and scene, these are listed in
+   additional columns.
+
+   You can also add a synopsis to each chapter or scene, which can be listed here as well. You have
+   the option to add or remove columns of information from this outline. A subset of the outline
+   information is also available in the **Novel View** as an alternative view to the project tree.
+
+**Get an overview of your story elements**
+   Under the document viewer panel you will find a series of tabs that show the different story
+   elements you have created tags for. The tabs are sorted into **Characters**, **Plots**, etc,
+   depending on which categories you are using in your story. This panel can be hidden to free up
+   space when you don't need it.
+
+**Assembling your manuscript**
+   Whether you want to assemble a manuscript, or export all your notes, or generate an outline of
+   your chapters and scenes with a synopsis included, you can use the **Build Manuscript** tool to
+   do so. The tool lets you select what information you want to include in the generated document,
+   and how it is formatted. You can send the result to a printer, or generate an Open Document or
+   Word Document file that can be opened by most office type word processors. You can also generate
+   the result as HTML, or Markdown, both suitable for further conversion to other formats.
 
 
 .. _a_intro_screenshots:
@@ -68,12 +118,12 @@ Below are some key features of novelWriter.
 Screenshots
 ===========
 
-**novelWriter with default theme:**
+.. figure:: images/screenshot_light.png
+   :class: dark-light
 
-.. image:: images/screenshot_default.png
-   :width: 800
+   novelWriter with light colour theme
 
-**novelWriter with dark theme:**
+.. figure:: images/screenshot_dark.png
+   :class: dark-light
 
-.. image:: images/screenshot_dark.png
-   :width: 800
+   novelWriter with dark colour theme

docs/source/int_overview.rst

@@ -1,92 +1,88 @@
-.. _a_overview:
+.. _a_reading:
 
-********
-Overview
-********
+******************
+What to Read First
+******************
 
-.. only:: html
+The documentation of novelWriter is quite extensive. There are a lot of features to get used to,
+but you don't need to know all of them to get started.
 
-   .. image:: images/python_powered.png
-      :align: right
-      :width: 220
+The chapters below labelled "Essential Information" are the ones you need to know to use the
+application correctly. By "correctly" it is meant: in a way so novelWriter understands the basic
+structure of your text. It collects a lot of information from your text and uses it to display the
+structure of it in various ways to help you get an overview of your writing.
 
-novelWriter is built on `Python 3 <https://www.python.org/>`_, a cross platform programming
-language that doesn't require a compiler to build and run. That means that the code can run on your
-computer right out of the box, or from a zip file.
+The chapters labelled "Recommended Reading" includes additional information on how the different
+parts if the application work and what the features do. 
 
-While it is developed for Linux primarily, it runs just fine on Windows as well. It also works fine
-on macOS, but the author is not a mac user, so support for mac is dependant on user feedback and
-contributions.
-
-In order to run novelWriter, you also need a few additional packages. The user interface is built
-with `Qt 5 <https://www.qt.io/>`_, a cross platform library for building graphical user interface
-applications. It also uses a third party XML package. If you want spell checking, you also need the
-spell check package Enchant developed for AbiWord
-
-For install instructions, see :ref:`a_started`.
-
-For information on how to add spell check dictionaries, see :ref:`a_custom_dict`.
+The "Optional" and "Lookup" chapters contain additional information or lookup tables that are not
+essential for using the application.
 
 
 Using novelWriter
 =================
 
 In order to use novelWriter effectively, you need to know the basics of how it works. The following
-sections will explain the main principles. It starts with the basics, and gets more detailed as you
+chapters will explain the main principles. They start with the basics, and get more detailed as you
 read on.
 
 :ref:`a_breakdown` – Essential Information
-   This section explains the basics of how the application works and what it can and cannot do.
+   This chapter explains the basics of how the application works and what it can and cannot do.
 
-:ref:`a_ui` – Recommended Reading
-   This section will give you a more detailed explanation of what the various elements on the user
-   interface do and how you can use them more effectively.
+:ref:`a_ui_project` – Recommended Reading
+   This chapter will give you a more detailed explanation of how you can use the user interface
+   components to organise and view your project work.
+
+:ref:`a_ui_writing` – Recommended Reading
+   This chapter will give you a more detailed explanation of how the text editor and viewer work.
 
 :ref:`a_fmt` – Essential Information
-   This section covers how you should format your text. The editor is plain text, so text
-   formatting requires some basic markup. The structure of your novel is also inferred by how you
-   use headings. Tags and references are implemented by simple codes.
+   This chapter covers how you should format your text. The editor is plain text, so text
+   formatting requires some basic markup. The structure of your novel is also inferred from how you
+   use headings. Tags and references are implemented by special keywords.
 
 :ref:`a_kb` – Optional / Lookup
-   This section lists all the keyboard shortcuts in novelWriter and what they do. Most of the
-   shortcuts are also listed next to the menu items inside the app, or in tool tips, so this
-   section is mostly for reference.
+   This chapter lists all the keyboard shortcuts in novelWriter and what they do. Most of the
+   shortcuts are also listed next to their menu entries inside the app, or in tool tips. This
+   chapter is mostly for reference.
 
 :ref:`a_typ` – Optional
-   This section gives you an overview of the special typographical symbols available in
+   This chapter gives you an overview of the special typographical symbols available in
    novelWriter. The auto-replace feature can handle the insertion of standard quote symbols for
-   your language, and other special characters. If you use any symbols aside from these. their
+   your language, and other special characters. If you use any symbols aside from these, their
    intended use is explained here.
 
-:ref:`a_prjfmt` – Optional
-   This section is more technical and has an overview of changes made to the way your project data
-   is stored. The format has changed a bit from time to time, and sometimes the changes require
-   that you make small modifications to your project. Everything you need to know is listed in this
-   section.
-
 
 Organising Your Projects
 ========================
 
-In addition to manage a collection of plain text files, novelWriter can interpret and map the
+In addition to managing a collection of plain text files, novelWriter can interpret and map the
 structure of your novel and show you additional information about its flow and content. In order
 to take advantage of these features, you must structure your text in a specific way and add some
 meta data for it to extract.
 
 :ref:`a_proj` – Essential Information
-   This section explains how you organise the content of your project, and how to set up automated
+   This chapter explains how you organise the content of your project, and how to set up automated
    backups of your work.
 
 :ref:`a_struct` – Essential Information
-   This section covers the way your novel's structure is encoded into the text documents. It
-   explains how the different levels of headings are used, and how you can include information
-   about characters, plot elements, and other meta data in your text.
+   This chapter covers the way your novel's structure is encoded into the text documents. It
+   explains how the different levels of headings are used, and some special formatting for
+   different kinds of headings.
 
-:ref:`a_notes` - Recommended Reading
-   This section briefly describes what novelWriter does with the note files you add to your
-   project. Generally, the application doesn't do much with them at all aside from looking through
-   them for tags you've set so that it knows which file to open when you click on a reference.
+:ref:`a_references` - Recommended Reading
+   This chapter explains how you organise your notes, and how the Tags and References system works.
+   This system lets you cross-link your documents in your project, and display these references in
+   the application interface.
 
-:ref:`a_export` - Recommended Reading
-   This section explains in more detail how the build tool works. In particular how you can
-   control the way chapter titles are formatted, and how scene and section breaks are handled.
+:ref:`a_manuscript` - Recommended Reading
+   This chapter explains how the **Manuscript Build** tool works, how you can control the way
+   chapter titles are formatted, and how scene and section breaks are handled.
+
+
+Additional Details & Technical Topics
+=====================================
+
+The Additional Details and the Technical Topics sections contain more in-depth information about
+how various bits of novelWriter works. This information is not essential to getting started using
+novelWriter.

docs/source/int_started.rst

@@ -1,61 +1,56 @@
 .. _a_started:
 
-***************
-Getting Started
-***************
+**********************
+Setup and Installation
+**********************
 
-.. _brew docs: https://docs.brew.sh/Homebrew-and-Python
-.. _Enchant: https://abiword.github.io/enchant/
+.. _Enchant: http://rrthomas.github.io/enchant/
 .. _GitHub: https://github.com/vkbo/novelWriter
-.. _macOS: https://github.com/vkbo/novelWriter/issues/867
-.. _main website: https://novelwriter.io
+.. _Downloads page: https://download.novelwriter.io
 .. _PPA: https://launchpad.net/~vkbo/+archive/ubuntu/novelwriter
 .. _Pre-Release PPA: https://launchpad.net/~vkbo/+archive/ubuntu/novelwriter-pre
 .. _PyPi: https://pypi.org/project/novelWriter/
-.. _python.org: https://www.python.org/downloads/windows
+.. _python.org: https://www.python.org/downloads/
 .. _Releases: https://github.com/vkbo/novelWriter/releases
-.. _RPM: https://github.com/vkbo/novelWriter/issues/907
 .. _AppImage: https://appimage.org/
 
-If you are using Windows or a Debian-based Linux distribtuion, you can install novelWriter from
-package installers. If you are on macOS, you have the option to run novelWriter from a standalone
-folder. See :ref:`a_started_minimal`. This option is also available for Windows and Linux. The
-third option is to install novelWriter from the Python Package Index. See :ref:`a_started_pip`.
+Ready-made packages and installers for novelWriter are available for all major platforms, including
+Linux, Windows and MacOS, from the `Downloads page`_. See below for additional install instructions
+for each platform.
+
+You can also install novelWriter from the Python Package Index (PyPi_). See :ref:`a_started_pip`.
+Installing from PyPi does not set up icon launchers, so you will either have to do this yourself,
+or start novelWriter from the command line.
 
 Spell checking in novelWriter is provided by a third party library called Enchant_. Generally, it
 should pull dictionaries from your operating system automatically. However, on Windows they must be
 installed manually. See :ref:`a_custom_dict` for more details.
 
-.. admonition:: Help Wanted
-   :class: seealso
-
-   If you would like to help making more installers, the project is currently looking for people
-   who can help make releases for Red Hat-based Linux distros (RPM) and for macOS. See the issues
-   posted for RPM_ and macOS_ on GitHub_.
-
 
 .. _a_started_windows:
 
-Install on Windows
-==================
+Installing on Windows
+=====================
 
 You can install novelWriter with both Python and library dependencies embedded using the Windows
-Installer (setup.exe) file from the `main website`_, or from the Releases_ page on GitHub.
+Installer (setup.exe) file from the `Downloads page`_, or from the Releases_ page on GitHub_.
 Installing it should be straightforward.
 
 If you have any issues, try uninstalling the previous version and making a fresh install. If you
-already had a version installed via a different method, you should uninstall that first.
+already had a version installed via a different method, you should uninstall that first as having
+multiple installations has been known to cause problems.
 
 
 .. _a_started_linux:
 
-Install on Linux
-================
+Installing on Linux
+===================
 
-A Debian package can be downloaded from the `main website`_, or from the Releases_ page on GitHub.
-This package should work on both Debian, Ubuntu and Linux Mint, at least.
+A Debian package can be downloaded from the `Downloads page`_, or from the Releases_ page on
+GitHub_. This package should work on both Debian, Ubuntu and Linux Mint, at least.
 
 If you prefer, you can also add the novelWriter repository on Launchpad to your package manager.
+The Launchpad packages `are signed by the author <https://launchpad.net/~vkbo>`__.
 
 
 Ubuntu
@@ -69,21 +64,21 @@ You can add the Ubuntu PPA_ and install novelWriter with the following commands.
    sudo apt update
    sudo apt install novelwriter
 
-If you want pre-releases, add the ``ppa:vkbo/novelwriter-pre`` repository instead.
+If you want the `Pre-Release PPA`_ instead, add the ``ppa:vkbo/novelwriter-pre`` repository.
 
 
 Debian and Mint
 ---------------
 
 Since this is a pure Python package, the Launchpad PPA can in principle also be used on Debian or
-Mint. However, the above command will fail to add the signing key.
+Mint. However, the above command will fail to add the signing key, as it is Ubuntu-specific.
 
 Instead, run the following commands to add the repository and key:
 
 .. code-block:: bash
 
    sudo gpg --no-default-keyring --keyring /usr/share/keyrings/novelwriter-ppa-keyring.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys F19F1FCE50043114
-   echo "deb [signed-by=/usr/share/keyrings/novelwriter-ppa-keyring.gpg] http://ppa.launchpad.net/vkbo/novelwriter/ubuntu focal main" | sudo tee /etc/apt/sources.list.d/novelwriter.list
+   echo "deb [signed-by=/usr/share/keyrings/novelwriter-ppa-keyring.gpg] http://ppa.launchpad.net/vkbo/novelwriter/ubuntu noble main" | sudo tee /etc/apt/sources.list.d/novelwriter.list
 
 Then run the update and install commands as for Ubuntu:
 
@@ -92,10 +87,13 @@ Then run the update and install commands as for Ubuntu:
    sudo apt update
    sudo apt install novelwriter
 
-.. note::
+.. tip::
+   If you get an error message like ``gpg: failed to create temporary file`` when importing the key
+   from the Ubuntu keyserver, try creating the folder it fails on, and import the key again:
 
-   Please use the Ubuntu 20.04 (focal) packages for Debian. The newer Ubuntu packages use a
-   different compression algorithm that Debian doesn't currently support.
+   .. code-block:: bash
+
+      sudo mkdir /root/.gnupg/
 
 
 AppImage Releases
@@ -105,125 +103,50 @@ For other Linux distros than the ones mentioned above, the primary option is App
 completely standalone images for the app that include the necessary environment to run novelWriter.
 They can of course be run on any Linux distro, if you prefer this to native packages.
 
-
-.. _a_started_minimal:
-
-Minimal Package Install
-=======================
-
-On the `main website`_ and on the Releases_ page on GitHub you will also find "Minimal Package"
-install files for Windows, Linux and macOS. These are zip files of just the files you need to run
-novelWriter on that specific platform.
-
-These zip files don't include any dependencies, so you must install them separately.
+.. note::
+   novelWriter generally doesn't support Python versions that have reached end of life. If your
+   Linux distro still uses older Python versions and novelWriter won't run, you may want to try the
+   AppImage instead.
 
 
-.. _a_started_minimal_windows:
+.. _a_started_macos:
 
-Minimal Package on Windows
---------------------------
+Installing on MacOS
+===================
 
-First, make sure you have Python installed on your system. If you don't, you can download it from
-`python.org`_. Python 3.7 or higher is required, but it is recommended that you install the latest
-version.
+You can install novelWriter with both its Python and library dependencies embedded using the DMG
+application image file from the `Downloads page`_, or from the Releases_ page on GitHub_.
+Installing it should be straightforward.
 
-Make sure you select the "Add Python to PATH" option during installation, otherwise the ``python``
-command will not work in the command line window.
+* Download the DMG file and open it. Then drag the novelWriter icon to the :guilabel:`Applications`
+  folder on the right. This will install it into your :guilabel:`Applications`.
+* The first time you try to launch it, it will say that the bundle cannot be verified, simply press
+  the :guilabel:`Open` button to add an exception.
+* If you are not presented with an :guilabel:`Open` button in the dialog, launch the application
+  again by right clicking on the application in Finder and selecting :guilabel:`Open` from the
+  context menu.
 
-.. figure:: images/python_win_install.png
-   :align: center
-   :width: 500
-
-When Python is installed, extract the novelWriter zip file and move the extracted folder to a
-suitable location. You should probably not keep it on your desktop or in your downloads folder
-where it may be accidentally deleted. Instead, move and rename it to for instance
-``C:\novelWriter``.
-
-After you've got the folder where you want it, open it and double-click the file named
-``windows_install.bat``. This will open a command line window and run the setup script to install
-dependencies, and add desktop and start menu icons.
-
-Running ``windows_uninstall.bat`` will reverse the process if you wish to uninstall. After that,
-you can just delete the novelWriter folder.
-
-
-.. _a_started_minimal_linux:
-
-Minimal Package on Linux
-------------------------
-
-On Linux you need to install the following packages on Debian-based distros, including Ubuntu and
-Linux Mint:
-
-.. code-block:: bash
-
-   sudo apt install python3-pyqt5 python3-lxml python3-enchant
-
-On Fedora, you need the following packages:
-
-.. code-block:: bash
-
-   sudo dnf install python3-qt5 python3-lxml python3-enchant
-
-A standard desktop launcher can be installed via the main setup script. It will create the needed
-desktop file and add it to the Applications menu. The necessary icons will also be installed, and a
-file association with ``.nwx`` project files added.
-
-To set this up, run the following from inside the extracted novelWriter folder:
-
-.. code-block:: bash
-
-   python3 setup.py xdg-install
-
-This installs icons for the current user. Run with ``sudo`` to install system-wide.
-
-To uninstall the icons, run:
-
-.. code-block:: bash
-
-   python3 setup.py xdg-uninstall
-
-
-.. _a_started_minimal_mac:
-
-Minimal Package on macOS
-------------------------
-
-These instructions assume you're using brew, and have Python and pip set up. If not, see the
-`brew docs`_ for help. The main requirements for novelWriter are installed via the requirements
-file. You also need to install the ``pyobjc`` package, so you should run:
-
-.. code-block:: bash
-
-   pip3 install --user -r requirements.txt
-   pip3 install --user pyobjc
-
-For spell checking you may also need to install the enchant package. It comes with a lot of default
-dictionaries.
-
-.. code-block:: bash
-
-   brew install enchant
-
-With the dependencies in place, you can launch the ``novelWriter.py`` script directly to run
-novelWriter.
+The context menu can also be accessed by option-clicking if you have a one button mouse. This is
+done by holding down the option key on your keyboard and clicking on the application in Finder.
 
 .. note::
-   Right now there isn't a better integration with macOS available. Contributions from someone more
-   familiar with macOS would be very much appreciated. See the macOS_ issue on GitHub.
+   The novelWriter DMG is not signed because Apple doesn't currently provide a way for non-profit
+   open source projects to properly sign their installers. The novelWriter project doesn't have the
+   funding to pay for a commercial software signing certificate.
 
 
 .. _a_started_pip:
 
-Install from PyPi
-=================
+Installing from PyPi
+====================
 
 novelWriter is also available on the Python Package Index, or PyPi_. This install method works on
-all supported operating systems.
+all supported operating systems with a suitable Python environment.
 
 To install from PyPi you must first have the ``python`` and ``pip`` commands available on your
-system. If you don't, see specific instructions for your operating system in this documentation on
-how to get the Python environment set up.
+system. You can download Python from `python.org`_. It is recommended that you install the latest
+version. If you are on Windows, also make sure to select the "Add Python to PATH" option during
+installation.
 
 To install novelWriter from PyPi, use the following command:
 
@@ -244,7 +167,4 @@ When installing via pip, novelWriter can be launched from command line with:
    novelwriter
 
 Make sure the install location for pip is in your PATH variable. This is not always the case by
-default.
-
-.. note::
-   On systems with both Python 2 and 3, you may have to replace the ``pip`` command with ``pip3``.
+default, and then you may get a "Not Found" error when running the ``novelwriter`` command.

docs/source/more_counting.rst

@@ -0,0 +1,98 @@
+.. _a_counting:
+
+********************
+Word and Text Counts
+********************
+
+This is an overview of how words and other counts of your text are performed. The counting rules
+should be relatively standard, and are compared to Libre Office Writer rules.
+
+The counts provided in the app on the raw text is meant to be approximate. For more accurate
+counts, you need to build your manuscript in the **Manuscript Tool** and check the counts on the
+generated preview.
+
+
+Text Word Counts and Stats
+==========================
+
+These are the rules for the main counts available for for each document in a project.
+
+For all counts, the following rules apply.
+
+#. Short (–) and long (—) dashes are considered word separators.
+#. Any line starting with ``%`` or ``@`` is ignored.
+#. Trailing white spaces are ignored, including line breaks.
+#. Leading ``>`` and trailing ``<`` are ignored with any spaces next to them.
+#. Valid shortcodes and other commands wrapped in brackets ``[]`` are ignored.
+#. In-line Markdown syntax in text paragraphs is treated as part of the text.
+
+After the above preparation of the text, the following counts are available.
+
+**Character Count**
+   The character count is the sum of characters per line, including leading and in-text white space
+   characters, but excluding trailing white space characters. Shortcodes in the text are not
+   included, but Markdown codes are. Only headings and text are counted.
+
+**Word Count**
+   The words count is the sum of blocks of continuous character per line separated by any number of
+   white space characters or dashes. Only headings and text are counted.
+
+**Paragraph Count**
+   The paragraph count is the number of text blocks separated by one or more empty line. A line
+   consisting only of white spaces is considered empty.
+
+
+Manuscript Counts
+=================
+
+These are the rules for the counts available for a manuscript in the **Manuscript Tool**. The rules
+have been tuned to agree with LibreOffice Writer, but will vary slightly depending on the content
+of your text. LibreOffice Writer also counts the text in the page header, which the **Manuscript
+Tool** does not.
+
+The content of each line is counted after all formatting has been processed, so the result will be
+more accurate than the counts for text documents elsewhere in the app. The following rules apply:
+
+#. Short (–) and long (—) dashes are considered word separators.
+#. Leading and trailing white spaces are generally included, but paragraph breaks are not.
+#. Hard line breaks within paragraph are considered white space characters.
+#. All formatting codes are ignored, including shortcodes, commands and Markdown.
+#. Scene and section separators are counted.
+#. Comments and meta data lines are counted after they are formatted.
+#. Headers are counted after they are formatted with custom formats.
+
+The following counts are available:
+
+**Headings**
+   The number of headings in the manuscript.
+
+**Paragraphs**
+   The number of body text paragraphs in the manuscript.
+
+**Words**
+   The number of words in the manuscript, including any comments and meta data text.
+
+**Words in Text**
+   The number of words in body text paragraphs, excluding all other text.
+
+**Words in Headings**
+   The number of words in headings, including inserted formatting like chapter numbers, etc.
+
+**Characters**
+   The number of characters in all lines, including any comments and meta data text. Paragraph
+   breaks are not counted, but in-paragraph hard line breaks are.
+
+**Character in Text**
+   The number of characters in body text paragraphs. Paragraph breaks are not counted, but
+   in-paragraph hard line breaks are.
+
+**Characters in Headings**
+   The number of characters in headings.
+
+**Character in Text, No Spaces**
+   The number of characters in body text paragraphs considered part of a word or punctuation. That
+   is, white space characters are not counted.
+
+**Character in Headings, No Spaces**
+   The number of characters in headings considered part of a word or punctuation. That is, white
+   space characters are not counted.

docs/source/more_customise.rst

@@ -0,0 +1,211 @@
+.. _a_custom:
+
+**************
+Customisations
+**************
+
+.. _Enchant: https://rrthomas.github.io/enchant/
+.. _Free Desktop: https://cgit.freedesktop.org/libreoffice/dictionaries/tree/
+
+There are a few ways you can customise novelWriter yourself. Currently, you can add new GUI themes,
+your own syntax themes, and install additional dictionaries.
+
+
+.. _a_custom_dict:
+
+Spell Check Dictionaries
+========================
+
+novelWriter uses Enchant_ as the spell checking tool. Depending on your operating system, it may or
+may not load all installed spell check dictionaries automatically.
+
+Linux and MacOS
+---------------
+
+On Linux and MacOS, you generally only have to install hunspell, aspell or myspell dictionaries on
+your system like you do for other applications. See your distro or OS documentation for how to do
+this. These dictionaries should show up as available spell check languages in novelWriter.
+
+Windows
+-------
+
+For Windows, English is included with the installation. For other languages you have to download
+and add dictionaries yourself.
+
+**Install Tool**
+
+A small tool to assist with this can be found under **Tools > Add Dictionaries**. It will import
+spell checking dictionaries from Free Office or Libre Office extensions. The dictionaries are then
+installed in the install location for the Enchant library and should thus work for any application
+that uses Enchant for spell checking.
+
+**Manual Install**
+
+If you prefer to do this manually or want to use a different source than the ones mentioned above,
+You need to get compatible dictionary files for your language. You need two files files ending with
+``.aff`` and ``.dic``. These files must then be copied to the following location: 
+
+``C:\Users\<USER>\AppData\Local\enchant\hunspell``
+
+This assumes your user profile is stored at ``C:\Users\<USER>``. The last one or two folders may
+not exist, so you may need to create them.
+
+You can find the various dictionaries on the `Free Desktop`_ website.
+
+.. note::
+   The Free Desktop link points to a repository, and what may look like file links inside the
+   dictionary folder are actually links to web pages. If you right-click and download those, you
+   get HTML files, not dictionaries!
+
+   In order to download the actual dictionary files, right-click the "plain" label at the end of
+   each line and download that.
+
+
+.. _a_custom_theme:
+
+Syntax and GUI Themes
+=====================
+
+Adding your own GUI and syntax themes is relatively easy, although it requires that you manually
+edit config files with colour values. The themes are defined by simple plain text config files with
+meta data and colour settings.
+
+In order to make your own versions, first copy one of the existing files to your local computer and
+modify it as you like.
+
+* The existing syntax themes are stored in
+  `novelwriter/assets/syntax <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/syntax>`_.
+* The existing GUI themes are stored in
+  `novelwriter/assets/themes <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/themes>`_.
+* The existing icon themes are stored in
+  `novelwriter/assets/icons <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/icons>`_.
+
+Remember to also change the name of your theme by modifying the ``name`` setting at the top of the
+file, otherwise you may not be able to distinguish them in **Preferences**.
+
+For novelWriter to be able to locate the custom theme files, you must copy them to the
+:ref:`a_locations_data` location in your home or user area. There should be a folder there named
+``syntax`` for syntax themes, just ``themes`` for GUI themes, and ``icons`` for icon themes. These
+folders are created the first time you start novelWriter.
+
+Once the files are copied there, they should show up in **Preferences** with the label you
+set as ``name`` inside the file.
+
+.. versionadded:: 2.0
+   The ``icontheme`` value was added to GUI themes. Make sure you set this value in existing custom
+   themes. Otherwise, novelWriter will try to guess your icon theme, and may not pick the most
+   suitable one.
+
+
+Custom GUI and Icons Theme
+--------------------------
+
+A GUI theme ``.conf`` file consists of the following settings:
+
+.. code-block:: cfg
+
+   [Main]
+   name        = My Custom Theme
+   description = A description of my custom theme
+   author      = Jane Doe
+   credit      = John Doe
+   url         = https://example.com
+   license     = CC BY-SA 4.0
+   licenseurl  = https://creativecommons.org/licenses/by-sa/4.0/
+   icontheme   = typicons_light
+
+   [Palette]
+   window          = 100, 100, 100
+   windowtext      = 100, 100, 100
+   base            = 100, 100, 100
+   alternatebase   = 100, 100, 100
+   text            = 100, 100, 100
+   tooltipbase     = 100, 100, 100
+   tooltiptext     = 100, 100, 100
+   button          = 100, 100, 100
+   buttontext      = 100, 100, 100
+   brighttext      = 100, 100, 100
+   highlight       = 100, 100, 100
+   highlightedtext = 100, 100, 100
+   link            = 100, 100, 100
+   linkvisited     = 100, 100, 100
+
+   [GUI]
+   helptext        =   0,   0,   0
+   fadedtext       = 128, 128, 128
+   errortext       = 255,   0,   0
+   statusnone      = 120, 120, 120
+   statussaved     =   2, 133,  37
+   statusunsaved   = 200,  15,  39
+
+In the Main section you must at least define the ``name`` and ``icontheme`` settings. The
+``icontheme`` settings should correspond to one of the internal icon themes, either
+``typicons_light`` or ``typicons_dark``, or to an icon theme in your custom icons directory. The
+setting must match the icon theme's folder name.
+
+The Palette values correspond to the Qt enum values for ``QPalette::ColorRole``, see the
+`Qt documentation <https://doc.qt.io/qt-5.15/qpalette.html#ColorRole-enum>`_ for more details. The
+colour values are RGB numbers on the format ``r, g, b`` where each is an integer from ``0`` to
+``255``. Omitted values are not loaded and will use default values. If the ``helptext`` colour is
+not defined, it is computed as a colour between the ``window`` and ``windowtext`` colour.
+
+.. versionadded:: 2.5
+   The ``fadedtext`` and ``errortext`` theme colour entries were added.
+
+
+Custom Syntax Theme
+-------------------
+
+A syntax theme ``.conf`` file consists of the following settings:
+
+.. code-block:: cfg
+
+   [Main]
+   name       = My Syntax Theme
+   author     = Jane Doe
+   credit     = John Doe
+   url        = https://example.com
+   license    = CC BY-SA 4.0
+   licenseurl = https://creativecommons.org/licenses/by-sa/4.0/
+
+   [Syntax]
+   background     = 255, 255, 255
+   text           =   0,   0,   0
+   link           =   0,   0,   0
+   headertext     =   0,   0,   0
+   headertag      =   0,   0,   0
+   emphasis       =   0,   0,   0
+   dialog         =   0,   0,   0
+   altdialog      =   0,   0,   0
+   note           =   0,   0,   0
+   hidden         =   0,   0,   0
+   shortcode      =   0,   0,   0
+   keyword        =   0,   0,   0
+   tag            =   0,   0,   0
+   value          =   0,   0,   0
+   optional       =   0,   0,   0
+   spellcheckline =   0,   0,   0
+   errorline      =   0,   0,   0
+   replacetag     =   0,   0,   0
+   modifier       =   0,   0,   0
+   texthighlight  = 255, 255, 255, 128
+
+In the Main section, you must define at least the ``name`` setting. The Syntax colour values are
+RGB(A) numbers of the format ``r, g, b, a`` where each is an integer from ``0`` to ``255``. The
+fourth value is the alpha channel, which can be omitted.
+
+Omitted syntax colours default to black, except ``background`` which defaults to white, and
+``texthighlight`` which defaults to white with half transparency.
+
+.. versionadded:: 2.2
+   The ``shortcode`` syntax colour entry was added.
+
+.. versionadded:: 2.3
+   The ``optional`` syntax colour entry was added.
+
+.. versionadded:: 2.4
+   The ``texthighlight`` syntax colour entry was added.
+
+.. versionadded:: 2.5
+   The ``dialog``, ``altdialog``, ``note`` and ``tag`` syntax colour entries were added.
+   ``straightquotes``, ``doublequotes`` and ``singlequotes`` were removed.

docs/source/more_projectformat.rst

@@ -5,21 +5,20 @@ Project Format Changes
 **********************
 
 .. _File Format Spec 1.5: _static/fileformatspec15.pdf
-.. _documentation: https://novelwriter.readthedocs.io
+.. _documentation: https://docs.novelwriter.io/
 
 Most of the changes to the file formats over the history of novelWriter have no impact on the
-user-side of things. The project files are generally updated automatically. However, some of the
+user side of things. The project files are generally updated automatically. However, some of the
 changes require minor actions from the user.
 
-The key changes in the formats are listed below, as well as the user actions required, where
-applicable.
+The key changes in the formats are listed in this chapter, as well as the user actions required,
+where applicable.
 
 .. only:: not html
 
    A full project file format specification is available in the online documentation_.
 
 .. caution::
-
    When you update a project from one format version to the next, the project can no longer be
    opened by a version of novelWriter prior to the version where the new file format was
    introduced. You will get a notification about any updates to your project file format and will
@@ -29,7 +28,8 @@ applicable.
 
    **For Developers**
 
-   A full description of the current file format is available in the `File Format Spec 1.5`_
+   A full description of the current file format is available in the
+   :download:`File Format Spec 1.5 <fileformatspec15.pdf>`
    document, available as a PDF. This document is intended for contributors to novelWriter, those
    building project conversion tools, either to or from tne novelWriter format, and for those who
    wish to make their own templating system.
@@ -70,7 +70,7 @@ Format 1.3 Changes
 
 This project format was introduced in novelWriter version 1.5.
 
-With this format, the number of document layouts was reduced from 8 to 2. The conversion of
+With this format, the number of document layouts was reduced from eight to two. The conversion of
 document layouts is performed automatically when the project is opened.
 
 Due to the reduction of layouts, some features that were previously controlled by these layouts
@@ -84,7 +84,7 @@ should be used only a few places in any given project. These are as follows:
 
 * The formatting of the level one title on the title page must be changed from ``# Title Text`` to
   ``#! Title Text`` in order to retain the previous functionality. See :ref:`a_fmt_head`.
-* Any text that was previously centred on the page must be manually centred using the new text
+* Any text that was previously centred on the page must be manually centred using the text
   alignment feature. See :ref:`a_fmt_align`.
 
 **Unnumbered Chapters**

docs/source/project_export.rst

@@ -1,159 +0,0 @@
-.. _a_export:
-
-***********************
-Building the Manuscript
-***********************
-
-You can at any time build a manuscript, an outline of your notes, or any other type of document
-from the text in your project. All of this is handled by the :guilabel:`Build Novel Project` tool.
-You can activate it from the sidebar, the :guilabel:`Tools` menu, or by pressing :kbd:`F5`.
-
-.. note::
-   This tool is scheduled to receive a full update in novelWriter 2.1, adding many new features
-   requested by users. See the `2.1 Milestone <https://github.com/vkbo/novelWriter/milestone/43>`_
-   for an overview.
-
-
-.. _a_export_headers:
-
-Header Formatting
-=================
-
-The titles for the five types of headings (the chapter headings come in a numbered and unnumbered
-version) of story structure can be formatted collectively in the build tool. This is done through
-a series of keyword–replace steps. They are all on the format ``%keyword%``.
-
-``%title%``
-   This keyword will always be replaced with the title text you put after the ``#`` characters in
-   your document.
-
-``%ch%``
-   This will be replaced by a chapter number. The number is incremented by one each time the build
-   tool sees a new heading of level two in a document, unless the heading formatting code has the
-   added ``!``. In the latter case, the counter is *not* incremented. This is useful for for
-   instance Prologue and Epilogue chapters.
-
-``%chw%``
-   Behaves like ``%ch%``, but the number is represented as a number word. You can select between a
-   number of different languages.
-
-``%chi%``
-   Begaves like ``%ch%``, but represented as a lower case Roman number from 1 to 4999.
-
-``%chI%``
-   Behaves like ``%ch%``, but represented as an upper case Roman number from 1 to 4999.
-
-``%sc%``
-   This is the number counter equivalent for scenes. These are incremented each time a heading of
-   level three is encountered, but reset to 1 each time a chapter is encountered. They can thus be
-   used for counting scenes within a chapter.
-
-``%sca%``
-   Behaves like ``%sc%``, but the number is *not* reset to 1 for each chapter. Instead it runs from
-   1 from the beginning of the novel to produce an absolute scene count.
-
-``\\``
-   This inserts a line break within the title.
-
-.. note::
-   Header formatting only applies to novel documents. Headings in notes will be left as-is.
-
-**Example**
-
-* The format ``%title%`` just reproduces the title you set in the document.
-* The format ``Chapter %ch%: %title%`` produces something like "Chapter 1: My Chapter Title".
-* The format ``Scene %ch%.%sc%`` produces something like "Scene 1.2" for scene 2 in chapter 1.
-
-
-.. _a_export_scenes:
-
-Scene Separators
-================
-
-If you don't want any titles for your scenes (or for your sections if you have them), you can leave
-the formatting boxes empty. If so, an empty paragraph will be inserted between the scenes or
-sections instead, resulting in a gap in the text.
-
-Alternatively, if you want a separator between them, like the common ``* * *``, you can enter the
-desired separator text in the formatting box. In fact, if the format is a piece of static text, it
-will always be treated as a separator.
-
-
-.. _a_export_files:
-
-File Selection
-==============
-
-Which documents and notes are selected for the build can be controlled from the options on the left
-side of the dialog window. In addition, you can select to include the synopsis comments, regular
-comments, keywords, and even exclude the body text itself if you just want an outline.
-
-.. tip::
-   If you for instance want to export a document with an outline of the novel, you can enable
-   keywords and synopsis export and disable body text, thus getting a document with each heading
-   followed by the tags and references and the synopsis.
-
-If you need to exclude specific documents from your exports, like draft documents or documents you
-want to take out of your manuscript, but don't want to delete, you can set the documents as
-"inactive" in the project tree. :guilabel:`Build Novel Project` tool has a switch to collectively
-exclude inactive documents.
-
-
-.. _a_export_print:
-
-Printing
-========
-
-The print button allows you to print the content in the preview window. You can either print to one
-of your system's printers, or print directly to a file as PDF. You can also print to file from the
-regular print dialog. The direct to file option is just a shortcut.
-
-.. note::
-   The paper format should in all cases default to whatever your system default is. Of you want to
-   change it, you have to select it from the :guilabel:`Print Preview`` dialog.
-
-
-.. _a_export_formats:
-
-Export Formats
-==============
-
-Currently, six formats are supported.
-
-Open Document Format
-   The Build tool can produce either an ``.odt`` file, or an ``.fodt`` file. The latter is just a
-   flat version of the document format as a single XML file. Most rich text editors support the
-   former, and a few the latter.
-
-novelWriter HTML
-   The HTML format writes a single ``.htm`` file with minimal style formatting. The HTML document
-   is suitable for further processing by document conversion tools like Pandoc, for importing in
-   word processors, or for printing from browser.
-
-novelWriter Markdown
-   This is simply a concatenation of the project documents selected by the filters. The documents
-   are stacked together in the order they appear in the project tree, with comments, tags, etc.
-   included if they are selected. This is a useful format for exporting the project for later
-   import back into novelWriter.
-
-Standard/GitHub Markdown
-   The Markdown format comes in both Standard and GitHub flavour. The *only* difference in terms of
-   novelWriter functionality is the support for strikethrough text, which is not supported by the
-   Standard flavour, but *is* supported by the GitHub flavour.
-
-
-.. _a_export_options:
-
-Additional Formats
-==================
-
-In addition to the above document formats, the novelWriter HTML and Markdown formats can also be
-wrapped in a JSON file. These files will have a meta data entry and a body entry. For HTML, also
-the accompanying css styles are included.
-
-The text body is saved in a two-level list. The outer list contains one entry per document, in the
-order they appear in the project tree. Each document is then split up into a list as well, with one
-entry per paragraph it contains.
-
-These files are mainly intended for scripted post-processing for those who want that option. A JSON
-file can be imported directly into a Python dict object or a PHP array, to mentions a few options.

docs/source/project_manuscript.rst

@@ -0,0 +1,239 @@
+.. _a_manuscript:
+
+***********************
+Building the Manuscript
+***********************
+
+.. _Pandoc: https://pandoc.org/
+
+You can at any time build a manuscript, an outline of your notes, or any other type of document
+from the text in your project. All of this is handled by the **Manuscript Build** tool. You can
+activate it from the sidebar, the **Tools** menu, or by pressing :kbd:`F5`.
+
+.. versionadded:: 2.1
+
+   This tool is new for version 2.1. A simpler tool was used for earlier versions. The simpler tool
+   only allows you to define a single set of options for the build, but otherwise had much the same
+   functionality.
+
+
+.. _a_manuscript_main:
+
+The Manuscript Build Tool
+=========================
+
+.. figure:: images/fig_manuscript_build.png
+   :width: 80%
+
+   The **Manuscript Build** tool main window.
+
+The main window of the **Manuscript Build** tool contains a list of all the builds you have
+defined, a selection of settings, and a few buttons to generate preview, open the print dialog, or
+run the build to create a manuscript document.
+
+
+Outline and Word Counts
+-----------------------
+
+.. figure:: images/fig_manuscript_build_outline.png
+   :width: 80%
+
+   The **Manuscript Build** tool main window with the **Outline** visible.
+
+The **Outline** tab on the left lets you navigate the headings in the preview document. It will
+show up to scene level headings for novel documents, and level 2 headings for notes.
+
+A collapsible panel of word and character counts are also available below the preview document.
+These are calculated from the text you have included in the document, and are more accurate counts
+than what's available in the project tree since they are counted *after formatting*.
+
+For a detailed description on how they are counted, see :ref:`a_counting`.
+
+
+.. _a_manuscript_settings:
+
+Build Settings
+==============
+
+Each build definition can be edited by opening it in the **Manuscript Build Settings** dialog,
+either by double-clicking or by selecting it and pressing the edit button in the toolbar.
+
+.. tip::
+
+   You can keep the **Manuscript Build Settings** dialog open while testing the different options,
+   and just hit the :guilabel:`Apply` button. You can test the result of your settings by pressing
+   the :guilabel:`Preview` button in the main **Manuscript Build** window. When you're happy with
+   the result, you can close the settings.
+
+
+Document Selection
+------------------
+
+.. figure:: images/fig_build_settings_selections.png
+   :width: 80%
+
+   The **Selections** page of the **Manuscript Build Settings** dialog.
+
+The **Selections** page of the **Manuscript Build Settings** dialog allows you to fine tune which
+documents are included in the build. They are indicated by a green arrow icon in the last column.
+On the right you have some filter options for selecting content of a specific type, and a set of
+switches for which root folders to include.
+
+You can override the result of these filters by marking one or more documents and selecting to
+explicitly include or exclude them by using the buttons below the tree view. The last button can be
+used to reset the override and return control to the filter settings.
+
+In the figure, the green arrow icon and the blue pin icon indicates which documents are included,
+and the red forbidden icon indicates that a document is explicitly excluded.
+
+
+.. _a_manuscript_settings_head:
+
+Formatting Headings
+-------------------
+
+.. figure:: images/fig_build_settings_headings.png
+   :width: 80%
+
+   The **Headings** page of the **Manuscript Build Settings** dialog.
+
+The **Headings** page of the **Manuscript Build Settings** dialog allows you to set how the
+headings in your :term:`Novel Documents` are formatted. By default, the title is just copied as-is,
+indicated by the ``{Title}`` format. You can change this to for instance add chapter numbers and
+scene numbers, or insert character names, like shown in the figure above.
+
+Clicking the edit button next to a format will copy the formatting string into the edit box where
+it can be modified, and where a syntax highlighter will help indicate which parts are automatically
+generated by the build tool. The :guilabel:`Insert` button is a dropdown list of these formats, and
+selecting one will insert it at the position of the cursor.
+
+Any text you add that isn't highlighted in colours will remain in your formatted titles.
+``{Title}`` will always be replaced by the text in the heading from your documents.
+
+You can preview the result of these format strings by clicking :guilabel:`Apply`, and then clicking
+:guilabel:`Preview` in the **Manuscript Build** tool main window.
+
+
+Scene Separators
+^^^^^^^^^^^^^^^^
+
+If you don't want any titles for your scenes (or for your sections if you have them), you can leave
+the formatting boxes empty. If so, an empty paragraph will be inserted between the scenes or
+sections instead, resulting in a gap in the text. You can also switch on the :guilabel:`Hide`
+setting, which will ignore them completely. That is, there won't even be an extra gap inserted.
+
+Alternatively, if you want a separator text between them, like the common ``* * *``, you can enter
+the desired separator text as the format. If the format is any piece of static text, it will always
+be treated as a separator.
+
+
+.. _a_manuscript_settings_head_hard:
+
+Hard and Soft Scenes
+^^^^^^^^^^^^^^^^^^^^
+
+If you wish to distinguish between so-called soft and hard scene breaks, you can use the
+alternative scene heading format in your text. You can then give these headings a different
+formatting in the **Headings** settings.
+
+See :ref:`a_fmt_head` for more info on how to format headings in your text.
+
+
+Output Settings
+---------------
+
+The **Content**, **Format** and **Output** pages of the **Manuscript Build Settings** dialog
+control a number of other settings for the output. Some of these only apply to specific output
+formats, which is indicated by the section headings on the settings pages.
+
+
+.. _a_manuscript_build:
+
+Building Manuscript Documents
+=============================
+
+.. figure:: images/fig_build_build.png
+   :width: 80%
+
+   The **Manuscript Build** dialog used for writing the actual manuscript documents.
+
+When you press the :guilabel:`Build` button on the **Build Manuscript** tool main window, a special
+file dialog opens up. This is where you pick your desired output format and where to write the
+file.
+
+On the left side of the dialog is a list of all the available file formats, and on the right, a
+list of the documents which are included based on the build definition you selected. You can choose
+an output path, and set a base file name as well. The file extension will be added automatically.
+
+To generate the manuscript document, press the :guilabel:`Build` button. A small progress bar will
+show the build progress, but for small projects it may pass very fast.
+
+
+File Formats
+------------
+
+Currently, four document formats are supported.
+
+Open Document Format
+   The Build tool can produce either an ``.odt`` file, or an ``.fodt`` file. The latter is just a
+   flat version of the document format as a single XML file. Most rich text editors support the
+   former, and only a few the latter.
+
+Microsoft Word Document Format
+   The Microsoft Word Document format writes a single ``.docx`` file. It uses a fairly basic format
+   that should be compatible with most rich text editors.
+
+Portable Document Format (PDF)
+   The PDF is generated from a copy of the preview document, and should have the same formatting
+   capabilities as the preview. It's identical to what is produced if you select the print option
+   and print to PDF.
+
+novelWriter HTML
+   The HTML format writes a single ``.htm`` file with minimal style formatting. The HTML document
+   is suitable for further processing by document conversion tools like Pandoc_, for importing in
+   word processors, or for printing from browser.
+
+Standard/Extended Markdown
+   The Markdown format comes in both Standard and Extended flavour. The *only* difference in terms
+   of novelWriter functionality is the support for strike through text, which is not supported by
+   the Standard flavour.
+
+novelWriter Markup
+   This is simply a concatenation of the project documents selected by the filters into a ``.txt``
+   file. The documents are stacked together in the order they appear in the project tree, with
+   comments, tags, etc. included if they are selected. This is a useful format for exporting the
+   project for later import back into novelWriter.
+
+.. versionadded:: 2.6
+
+   Microsoft Word and PDF output options were added.
+
+
+Additional Formats
+------------------
+
+In addition to the above document formats, the novelWriter HTML and Markup formats can also be
+wrapped in a JSON file. These files will have a meta data entry and a body entry. For HTML, also
+the accompanying CSS styles used by the preview are included.
+
+The text body is saved in a two-level list. The outer list contains one entry per document, in the
+order they appear in the project tree. Each document is then split up into a list as well, with one
+entry per paragraph it contains.
+
+These files are mainly intended for scripted post-processing for those who want that option. A JSON
+file can be imported directly into a Python dict object or a PHP array, to mentions a few options.
+
+
+.. _a_manuscript_print:
+
+Printing
+========
+
+The :guilabel:`Print` button allows you to print the content in the preview window. You can either
+print to one of your system's printers, or select PDF as your output format from the printer icon
+on the print dialog.
+
+.. note::
+
+   The paper format should in all cases default to whatever your system default is. If you want to
+   change it, you have to select it from the **Print Preview** dialog.

docs/source/project_notes.rst

@@ -1,72 +0,0 @@
-.. _a_notes:
-
-*************
-Project Notes
-*************
-
-novelWriter doesn't have a database and complicated forms for filling in details about plot
-elements, characters, and all sorts of additional information that isn't a part of the novel text
-itself. Instead, all such information is saved in notes that are written and maintained just like
-all other text in your project.
-
-The relation between all these additional elements is extracted from the documents and notes by the
-project indexer, based on the tags and references you set within them.
-
-Using notes is not required, but making at least minimal notes for each plot element, and adding a
-tag to them, makes it possible to use the Outline View to see how each element intersects with each
-section of the novel itself, and adds clickable cross-references between documents in the editor
-and viewer.
-
-
-.. _a_notes_tags:
-
-Tags in Notes
-=============
-
-Each new heading in a note can have a tag associated with it. The format of a tag is
-``@tag: tagname``, where tagname is a unique identifier of your choosing. Tags can then be
-referenced in the novel documents, or cross-referenced in other notes, and will show up in the
-Outline View and in the back-reference panel when a document is opened in the viewer. See
-:ref:`a_struct_tags` for how to reference notes.
-
-The syntax highlighter will alert the user 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
-to date. An invalid tag should have a green wiggly line under it, and will not receive the syntax
-colour that valid tags do.
-
-The tag is the only part of these notes that the application uses. The rest of the document content
-is there for the writer to use in whatever way they wish. Of course, the content of the documents
-can be added 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:`Build Novel Project` tool.
-
-One note can also reference another note in the same way novel documents do. When the note is
-opened in the view panel, the references become clickable links, making it easier to follow
-connections in the plot. Notes don't show up in the Outline View though, so referencing between
-notes is only meaningful if you want to be able to click-navigate between them, or of course if you
-just want to highlight that two notes are related.
-
-.. tip::
-   If you cross-reference between notes and export your project as an HTML document using the
-   :guilabel:`Build Novel Project` tool, the cross-references become clickable links in the
-   exported HTML document.
-
-Example of a project note with two headers, with separate tags, and with references to other notes:
-
-.. code-block:: none
-   :linenos:
-
-   # Main Characters
-
-   ## Jane Doe
-
-   @tag: Jane
-   @location: Earth
-
-   Something about Jane ...
-
-   ## John Doh
-
-   @tag: John
-   @location: Mars
-
-   Something about John ...

docs/source/project_overview.rst

@@ -1,120 +1,130 @@
 .. _a_proj:
 
-**************
-Novel Projects
-**************
+*****************
+Managing Projects
+*****************
 
-New projects can be created from the :guilabel:`Project` menu by selecting :guilabel:`New Project`.
-This will open the :guilabel:`New Project Wizard` that will assist you in creating a barebone
-project suited to your needs.
+Your text in novelWriter is organised into projects. Each project is meant to contain one novel
+and associated notes. If you have multiple novels in a series, with the same characters and shared
+notes, it is also possible to keep all of them in the same project.
+
+.. _a_proj_new:
+
+Creating Project
+================
+
+New projects can be created from the **Project** menu by selecting **Create or Open Project**. This
+will open the **Welcome** dialog, where you can select the :guilabel:`New` button that will assist
+you in creating a new project. This dialog is also displayed when you start novelWriter.
 
 A novelWriter project requires a dedicated folder for storing its files on the local file system.
-See :ref:`a_storage` for further details on how files are organised.
+If you're interested in the details, you can have a look at the chapter :ref:`a_storage`.
 
-A list of recently opened projects is maintained, and displayed in the :guilabel:`Open Project`
-dialog. A project can be removed from this list by selecting it and pressing the :kbd:`Del` key or
-by clicking the :guilabel:`Remove` button.
+A list of recently opened projects is maintained, and displayed in the **Welcome** dialog. A
+project can be removed from this list by selecting it and pressing the :kbd:`Del` key or by
+right-clicking it and selecting the **Remove Project** option.
 
-Project-specific settings are available in :guilabel:`Project Settings` in the :guilabel:`Project`
-menu. See further details below in the :ref:`a_proj_settings` section. Details about the project,
-including word counts, and a table of contents with word and page counts, is available through the
-:guilabel:`Project Details` dialog.
+.. figure:: images/fig_welcome.jpg
+
+   The project list (left) and new project form (right) of the :guilabel:`Welcome` dialog.
+
+Project-specific settings are available in **Project Settings** in the **Project** menu. See
+further details below in the :ref:`a_proj_settings` section.
+
+Details about the project's novel text, including word counts, and a table of contents with word
+and page counts, is available through the **Novel Details** dialog. Statistics about the project
+is also available in the **Manuscript Build** tool.
+
+
+Template Projects
+-----------------
+
+From the Welcome dialog you can also create a new from another existing project. If you have a
+specific structure you want to use for all your new projects, you can create a dedicated project to
+be used as a template, and select to copy an existing project from the :guilabel:"Prefill Project"
+option from the **New Project** form.
 
 
 .. _a_proj_roots:
 
-Project Roots
-=============
+Project Structure
+=================
 
 Projects are structured into a set of top level folders called "Root Folders". They are visible in
 the project tree at the left side of the main window.
 
-The novel documents go into a root folder of type :guilabel:`Novel`. Project notes go into the
-other root folders. These other root folder types are intended for your notes on the various
+The :term:`novel documents` go into a root folder of type **Novel**. :term:`Project notes` go into
+the other root folders. These other root folder types are intended for your notes on the various
 elements of your story. Using them is of course entirely optional.
 
 A new project may not have all of the root folders present, but you can add the ones you want from
 the project tree tool bar.
 
-Each root folder has one or more reference keyword associated with it that is used to reference
-them from other documents and notes. The intended usage of each type of root folder is listed
-below. However, aside from the :guilabel:`Novel` folder, no restrictions are applied by the
+Each root folder has one or more :term:`reference` :term:`keyword` associated with it that is used
+to reference them from other documents and notes. The intended usage of each type of root folder is
+listed below. However, aside from the **Novel** folder, no restrictions are applied by the
 application on what you put in them. You can use them however you want.
 
-.. tip::
-   You can make multiple root folders of each kind if you wish to split up your notes.
+The root folder system is closely connected to how the Tags and References system works. For more
+details, see the :ref:`a_references` chapter.
 
-.. note::
-   It is not the notes themselves that are referenced by the listed reference keywords, but tags
-   set within the notes. See the examples below and in :ref:`a_struct_tags`.
 
-:guilabel:`Novel`
-   This is the root folder of all text that goes into the final novel or novels. This class of
+Root Folder Types
+-----------------
+
+**Novel**
+   This is the root folder type for text that goes into the final novel or novels. This class of
    documents have other rules and features than the project notes. See :ref:`a_struct` for more
    details.
 
-:guilabel:`Plot`
-   This is the root folder where main plots can be outlined. It is optional, but adding at least
-   brief notes can be useful in order to tag plot elements for the Outline View. Tags in this
-   folder can be references using the ``@plot`` keyword.
+**Plot**
+   This is the root folder type where main plots can be outlined. It is optional, but adding at
+   least brief notes can be useful in order to tag plot elements for the **Outline View**. Tags in
+   this folder can be references using the ``@plot`` keyword.
 
-:guilabel:`Characters`
-   Character notes go in this root folder. These are especially important if you want to use the
-   Outline View to see which character appears where, and which part of the story is told from a
-   specific character's point-of-view, or focusing on a particular character's storyline. Tags in
-   this folder can be referenced using the ``@pov`` keyword for point-of-view characters,
-   ``@focus`` for a focus character, or the ``@char`` keyword for any other characters.
+**Characters**
+   Character notes go in this root folder type. These are especially important if you want to use
+   the **Outline View** to see which character appears where, which part of the story is told from
+   a specific character's point-of-view, or focusing on a particular character's storyline.
 
-:guilabel:`Locations`
-   The locations folder is for various scene locations that you want to track. Tags in this folder
-   can be references using the ``@location`` keyword.
+   The character names can also be inserted into for instance chapter titles when you create your
+   manuscript. Tags in this type of folder can be referenced using the ``@pov`` keyword for
+   point-of-view characters, ``@focus`` for a focus character, or the ``@char`` keyword for any
+   other character present.
 
-:guilabel:`Timeline`
-   If the story has multiple plot timelines or jumps in time within the same plot, this class of
-   notes can be used to track this. Tags in this folder can be references using the ``@time``
+**Locations**
+   The locations folder type is for various scene locations that you want to track. Tags in this
+   folder can be references using the ``@location`` keyword.
+
+**Timeline**
+   If the story has multiple plot timelines or jumps in time within the same plot, this folder type
+   can be used to track this. Tags in this type of folder can be references using the ``@time``
    keyword.
 
-:guilabel:`Objects`
-   Important objects in the story, for instance important objects that change hands often, can be
-   tracked here. Tags in this folder can be references using the ``@object`` keyword.
+**Objects**
+   Important objects in the story, for instance physical objects that change hands often, can be
+   tracked here. Tags in this type of folder can be references using the ``@object`` keyword.
 
-:guilabel:`Entities`
+**Entities**
    Does your plot have many powerful organisations or companies? Or other entities that are part of
-   the plot? They can be organised here. Tags in this folder can be references using the
+   the plot? They can be organised here. Tags in this type of folder can be references using the
    ``@entity`` keyword.
 
-:guilabel:`Custom`
-   The custom root folder can be used for tracking anything else not covered by the above options.
-   Tags in this folder can be references using the ``@custom`` keyword.
+**Custom**
+   The custom root folder type can be used for tracking anything else not covered by the above
+   options. Tags in this folder type can be references using the ``@custom`` keyword.
 
-The root folders correspond to the categories of tags that can be used to reference them. For more
-information about the tags listed, see :ref:`a_struct_tags`.
+The root folders are closely tied to the tags and reference system. Each folder type corresponds to
+categories of tags that can be used to reference them. For more information about the tags listed,
+see :ref:`a_references_references`.
+
+There is also a ``@mention`` keyword that can be used to reference any tag.
+See :ref:`a_references_references` for more details.
 
 .. note::
+
    You can rename root folders to whatever you want. However, this doesn't change the reference
-   keyword.
-
-Example of a character note:
-
-.. code-block:: none
-   :linenos:
-
-   # Jane Doe
-
-   @tag: Jane
-
-   Some information about the character Jane Doe.
-
-Example of a novel scene referencing the above character:
-
-.. code-block:: none
-   :linenos:
-
-   ### Chapter 1, Scene 1
-
-   @pov: Jane
-
-   When Jane woke up that morning ...
+   keyword or what they do.
 
 
 .. _a_proj_roots_del:
@@ -122,13 +132,12 @@ Example of a novel scene referencing the above character:
 Deleted Documents
 -----------------
 
-Deleted documents will be moved into a special :guilabel:`Trash` root folder. Documents in the
-trash folder can then be deleted permanently, either individually, or by emptying the trash from
-the menu. Documents in the trash folder are removed from the project index and cannot be
-referenced.
+Deleted documents are moved into a special **Trash** root folder. Documents in the trash folder can
+then be deleted permanently, either individually, or by emptying the trash from the menu. Documents
+in the trash folder are removed from the :term:`project index` and cannot be referenced.
 
-A document or a folder can be deleted from the :guilabel:`Project` menu, or by pressing
-:kbd:`Ctrl`:kbd:`Shift`:kbd:`Del`. Root folders can only be deleted when they are empty.
+A document or a folder can be moved to trash from the **Project** menu, or by pressing
+:kbd:`Ctrl+Shift+Del`. Root folders can only be removed when they are empty.
 
 
 .. _a_proj_roots_out:
@@ -136,60 +145,14 @@ A document or a folder can be deleted from the :guilabel:`Project` menu, or by p
 Archived Documents
 ------------------
 
-If you don't want to delete a document, or put it in the :guilabel:`Trash` folder where it may be
-deleted, but still want it out of your main project tree, you can create an :guilabel:`Archive`
-root folder.
+If you don't want to delete a document, or put it in the **Trash** folder where it may be deleted
+accidentally, but still want it out of your main project tree, you can create an **Archive** root
+folder instead and move it there. It has the same effect as moving it to **Trash**, but it is safe
+from deletion.
 
 You can drag any document to this folder and preserve its settings. The document will always be
-excluded from the :guilabel:`Build Novel Project` builds. It is also removed from the project
-index, so the tags and references defined in it will not show up anywhere else.
-
-
-.. _a_proj_roots_orph:
-
-Recovered Documents
--------------------
-
-If novelWriter crashes or otherwise exits without saving the project state, or if you're using a
-file synchronisation tool that runs out of sync, there may be files in the project folder that
-aren't tracked in the core project file. These files, when discovered, are recovered and added back
-into the project if possible.
-
-The discovered files are scanned for meta information that give clues as to where the document may
-previously have been located in the project. The project loading routines will try to put them back
-as close as possible to this location, if it still exists. Generally, it will be appended to the
-end of the folder where it previously was located. If that folder doesn't exist, it will try to add
-it to the correct root folder. If it cannot figure out which root folder is correct, the document
-will be added to the :guilabel:`Novel` root folder. Only if the :guilabel:`Novel` folder is
-missing will it give up.
-
-If the title of the document can be recovered, the word "Recovered:" will be added as a prefix. If
-the title cannot be determined, the document will be named "Recovered File N" where N is a
-sequential number.
-
-
-.. _a_proj_roots_lock:
-
-Project Lockfile
-----------------
-
-To prevent lost documents caused by file conflicts when novelWriter projects are synced with file
-synchronisation tools, a project lockfile is written to the project folder. If you try to open a
-project which has such a file present, you will be presented with a warning, and some information
-about where else novelWriter thinks the project is also open. You will be give the option to ignore
-this warning, and continue opening the project at your own risk.
-
-.. note::
-   If, for some reason, novelWriter crashes, the lock file may remain even if there are no other
-   instances keeping the project open. In such a case it is safe to ignore the lock file warning
-   when re-opening the project.
-
-.. warning::
-   If you choose to ignore the warning and continue opening the project, and multiple instances of
-   the project are in fact open, you are likely to cause inconsistencies and create diverging
-   project files, potentially resulting in loss of data and orphaned files. You are not likely to
-   lose any actual text unless both instances have the same document open in the editor, and
-   novelWriter will try to resolve project inconsistencies the next time you open the project.
+excluded from the **Build Manuscript** tool. It is also removed from the :term:`project index`, so
+the tags and references defined in it will not show up anywhere else.
 
 
 .. _a_proj_roots_dirs:
@@ -197,19 +160,68 @@ this warning, and continue opening the project at your own risk.
 Using Folders in the Project Tree
 ---------------------------------
 
-Folders, aside from root folders, have no structural significance to the project. When novelWriter
-is processing the documents in the novel, like for instance during export, these folders are
-ignored. Only the order of the documents themselves matter.
+Regular folders, those that are not root folders, have no structural significance to the project.
+When novelWriter is processing the documents in a project, like for instance when you create a
+manuscript from it, these folders are ignored. Only the order of the documents themselves matter.
 
-The folders are there purely as a way for the user to organise the documents in meaningful sections
-and to be able to collapse and hide them in the project tree when you're not working on those
+The folders are there purely as a way for you to organise the documents in meaningful sections and
+to be able to collapse and hide them in the project tree when you're not working on those
 documents.
 
-.. tip::
-   You can add child documents to other documents. This is particularly useful when you create
-   chapters and scenes. If you add separate scene documents, you should also add separate chapter
-   documents, even if they only contain a chapter heading. You can then add scene documents as
-   child items to the chapters.
+In addition to using folders. it is also possible to add child documents to other documents. This
+is particularly  useful when you create chapters and scenes. If you add separate scene documents,
+you should also  add separate chapter documents, even if they only contain a chapter heading. You
+can then add scene documents as child items to the chapters.
+
+
+.. _a_proj_roots_orphaned:
+
+Recovered Documents
+-------------------
+
+If novelWriter crashes or otherwise exits without saving the project state, or if you're using a
+file synchronisation tool that runs out of sync, there may be files in the project storage folder
+that aren't tracked in the core project file. These files, when discovered, are recovered and added
+back into the project when a project is opened.
+
+The discovered files are scanned for metadata that give clues as to where the document may
+previously have been located in the project. The project loading routine will try to put them back
+as close as possible to this location, if it still exists. Generally, it will be appended to the
+end of the folder where it previously was located. If that folder doesn't exist, it will try to add
+it to the correct root folder type. If it cannot figure out which root folder is correct, the
+document will be added to the **Novel** root folder. Finally, if a **Novel** does not exist, one
+will be created.
+
+If the title of the document can be recovered, the word "Recovered:" will be added as a prefix to
+indicate that it may need further attention. If the title cannot be determined, the document will
+be named after its internal key, which is a string of characters and numbers.
+
+
+.. _a_proj_roots_lock:
+
+Project Lockfile
+----------------
+
+To prevent data loss caused by file conflicts when novelWriter projects are synchronised via file
+synchronisation tools, a project lockfile is written to the project storage folder when a project
+is open. If you try to open a project which already has such a file present, you will be presented
+with a warning, and some information about where else novelWriter thinks the project is also open.
+You will be given the option to ignore this warning, and continue opening the project at your own
+risk.
+
+.. note::
+
+   If, for some reason, novelWriter or your computer crashes, the lock file may remain even if
+   there are no other instances keeping the project open. In such a case it is safe to ignore the
+   lock file warning when re-opening the project.
+
+.. warning::
+
+   If you choose to ignore the warning and continue opening the project, and multiple instances of
+   the project are in fact open, you are likely to cause inconsistencies and create diverging
+   project files, potentially resulting in loss of data and orphaned files. You are not likely to
+   lose any actual text unless both instances have the same document open in the editor, and
+   novelWriter will try to resolve project inconsistencies the next time you open the project.
 
 
 .. _a_proj_files:
@@ -217,15 +229,28 @@ documents.
 Project Documents
 =================
 
-New documents can be created from the tool bar in the Project Tree, or by pressing
-:kbd:`Ctrl`:kbd:`N`. This will open the create new item menu and let you choose between a number of
-pre-defined documents and folders. You will be prompted for a label for the new item. You can
-always rename an item by selecting :guilabel:`Rename Item` from the :guilabel:`Project` menu, or by
-pressing :kbd:`F2`.
+New documents can be created from the toolbar in the project tree, or by pressing :kbd:`Ctrl+N`.
+This will open the create new item menu and let you choose between a number of pre-defined
+documents and folders. You will be prompted for a label for the new item.
 
-Other settings for project items are available from the context menu that you can activate by
-right-clicking on an item in the Project Tree. The :guilabel:`Transform` submenu includes options
-for converting, splitting, or merging items.
+You can always rename an item by selecting **Rename Item** from the **Project** menu, or by
+pressing :kbd:`F2` when a document or folder is selected.
+
+Other settings for project documents and folders are available from the context menu that you can
+activate by right-clicking on an it in the tree. The **Transform** submenu includes options for
+converting, splitting, or merging documents. See :ref:`a_ui_tree_split_merge` for more details on
+the latter two.
+
+
+Document Templates
+------------------
+
+If you wish to create template documents to be used when creating new project documents, like for
+instance a character note template, you can add a **Templates** root folder to your project. Any
+document added to this root folder will show up in the **Add Item** menu in the project tree
+toolbar. When selected, a new document is created with its content copied from the chosen template.
+
+.. versionadded:: 2.3
 
 
 .. _a_proj_files_counts:
@@ -234,17 +259,20 @@ Word Counts
 -----------
 
 A character, word and paragraph count is maintained for each document, as well as for each section
-of a document following a header. The word count and change of words in the current session is
-displayed in the footer of any document open in the editor, and all stats are shown in the details
-panel below the project tree for any document selected in the project or novel tree.
+of a document following a :term:`heading<headings>`. The word count and change of words in the
+current session is displayed in the footer of any document open in the editor, and all stats are
+shown in the details panel below the project tree for any document selected in the project or novel
+trees.
 
 The word counts are not updated in real time, but run in the background every few seconds for as
 long as the document is being actively edited.
 
 A total project word count is displayed in the status bar. The total count depends on the sum of
-the values in the project tree, which again depend on an up to date index. If the counts seem
-wrong, a full project word recount can be initiated by rebuilding the project's index. Either form
-the :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
+the values in the project tree, which again depend on an up to date :term:`project index`. If the
+counts seem wrong, a full project word recount can be initiated by rebuilding the project's index.
+Either from the **Tools** menu, or by pressing :kbd:`F9`.
+
+The rules for how the counts are made is covered in more detail in :ref:`a_counting`.
 
 
 .. _a_proj_settings:
@@ -252,45 +280,51 @@ the :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
 Project Settings
 ================
 
-The :guilabel:`Project Settings` can be accessed from the :guilabel:`Project` menu, or by pressing
-:kbd:`Ctrl`:kbd:`Shift`:kbd:`,`. This will open a dialog box, with a set of tabs.
+The **Project Settings** can be accessed from the **Project** menu, or by pressing
+:kbd:`Ctrl+Shift+,`. This will open a dialog box, with a set of tabs.
 
 
 Settings Tab
 ------------
 
-The :guilabel:`Settings` tab holds the project name, title, and author settings.
+The **Settings** tab holds the project name, author, and language settings.
 
-The :guilabel:`Project Name` can be set to a different value than the :guilabel:`Novel Title`. The
-difference between them is simply that the :guilabel:`Project Name` is used for the GUI (main
-window title) and for generating the backup files. The intention is that the
-:guilabel:`Project Name` should remain unchanged throughout the project's lifetime, otherwise the
-name of exported files and backup files may change too.
+The **Project Name** can be edited here. It is used for the main window title and for generating
+backup files. So keep in mind that if you do change this setting, the backup file names will change
+too.
 
-The :guilabel:`Novel Title` and :guilabel:`Authors` settings are used when building the manuscript,
-for some formats.
+You can also change the **Authors** and **Project Language** setting. These are only used when
+building the manuscript, for some formats. The language setting is also used when inserting text
+into documents in the viewer, like for instance labels for keywords and special comments.
 
-If your project is in a different language than your main spell checking is set to, you can
-override the default spell checking language here. You can also override the automatic backup
-setting.
+If your project is in a different language than your main spell checking language is set to, you
+can override the default setting here. The project language can also be changed from the **Tools**
+menu.
+
+You can also override the automatic backup setting for the project if you wish.
 
 
 Status and Importance Tabs
 --------------------------
 
-Each document or folder of type :guilabel:`Novel` can be given a *Status*_* label accompanied by a
-coloured icon, and each document or folder of the remaining types can be given an *Importance*
-label.
+Each document or folder of type **Novel** can be given a "Status" label accompanied by a coloured
+icon with an optional shape selected from a list of pre-defined shapes. Each document or folder of
+the remaining types can be given an "Importance" label with the same customisation options.
 
-These are purely there for the user's convenience, and you are not required to use them for any
+These labels are there purely for your convenience, and you are not required to use them for any
 other features to work. No other part of novelWriter accesses this information. The intention is to
 use these to indicate at what stage of completion each novel document is, or how important the
 content of a note is to the story. You don't have to use them this way, that's just what they were
 intended for, but you can make them whatever you want.
 
+Both status and importance labels can be exported and imported so you can share them between
+projects, or define a standard set for all your writing projects. When you import labels to a
+project, they are always added as *new* labels.
+
 See also :ref:`a_ui_tree_status`.
 
 .. note::
+
    The status or importance level currently in use by one or more documents cannot be deleted, but
    they can be edited.
 
@@ -302,7 +336,7 @@ A set of automatically replaced keywords can be added in this tab. The keywords
 will be replaced by the text in the right column when documents are opened in the viewer. They will
 also be applied to manuscript builds.
 
-The auto-replace feature will replace text in angle brackets that are in this list. The syntax
+The auto-replace feature will replace text in angle brackets that is in this list. The syntax
 highlighter will add an alternate colour to text matching the syntax, but it doesn't check if the
 text is in this list.
 
@@ -318,22 +352,22 @@ Backup
 ======
 
 An automatic backup system is built into novelWriter. In order to use it, a backup path to where
-the backup files are to be stored must be provided in :guilabel:`Preferences`.
+the backup files are to be stored must be provided in **Preferences**. The path defaults to a
+folder named "Backups" in your home directory.
 
 Backups can be run automatically when a project is closed, which also implies it is run when the
 application itself is closed. Backups are date stamped zip files of the project files in the
 project folder (files not strictly a part of the project are ignored). The zip archives are stored
-in a subfolder of the backup path. The subfolder will have the same name as the
-:guilabel:`Project Name` as defined in :ref:`a_proj_settings`.
+in a subfolder of the backup path. The subfolder will have the same name as the **Project Name** as
+defined in :ref:`a_proj_settings`.
 
-The backup feature, when configured, can also be run manually from the :guilabel:`Tools` menu.
-It is also possible to disable automated backups for a given project in
-:guilabel:`Project Settings`.
+The backup feature, when configured, can also be run manually from the **Tools** menu. It is also
+possible to disable automated backups for a given project in **Project Settings**.
 
 .. note::
-   For the backup to be able to run, the :guilabel:`Project Name` must be set in
-   :guilabel:`Project Settings`. This value is used to generate the folder name for the zip files.
-   Without it, the backup will not run at all, but it will produce a warning message.
+   For the backup to be able to run, the **Project Name** must be set in **Project Settings**. This
+   value is used to generate the name and path of the backups. Without it, the backup will not run
+   at all, but it will produce a warning message.
 
 
 .. _a_proj_stats:
@@ -343,19 +377,33 @@ Writing Statistics
 
 When you work on a project, a log file records when you opened it, when you closed it, and the
 total word counts of your novel documents and notes at the end of the session, provided that the
-session lasted either more than 5 minutes, or that the total word count changed. You can view this
-file in the ``meta`` folder in the directory where you saved your project. The file is named
-``sessionStats.log``.
+session lasted either more than 5 minutes, or that the total word count changed. For more details
+about the log file, see :ref:`a_storage`.
 
-A tool to view the content of this file is available in the :guilabel:`Tools` menu under
-:guilabel:`Writing Statistics`. You can also launch it by pressing :kbd:`F6`, or find it on the
-Sidebar.
+A tool to view the content of the log file is available in the **Tools** menu under **Writing
+Statistics**. You can also launch it by pressing :kbd:`F6`, or find it on the sidebar.
 
 The tool will show a list of all your sessions, and a set of filters to apply to the data. You can
 also export the filtered data to a JSON file or to a CSV file that can be opened by a spreadsheet
-application like for instance Libre Office Calc.
+application like for instance Libre Office Calc or Excel.
 
-As of version 1.2, the log file also stores how much of the session time was spent idle. The
-definition of idle here is that the novelWriter main window loses focus, or the user hasn't made
-any changes to the currently open document in five minutes. The number of minutes can be altered in
-:guilabel:`Preferences`.
+.. versionadded:: 1.2
+
+   As of version 1.2, the log file also stores how much of the session time was spent idle. The
+   definition of idle here is that the novelWriter main window loses focus, or the user hasn't made
+   any changes to the currently open document in five minutes. The number of minutes can be altered
+   in **Preferences**.
+
+
+Session Timer
+-------------
+
+A session timer is by default visible in the status bar. The icon will show you a clock icon when
+you are active, and a pause icon when you are considered "idle" per the criteria mentioned above.
+
+If you do not wish to see the timer, you can click on it once to hide it. The icon will still be
+visible. Click the icon once more to display the timer again.
+
+.. versionadded:: 2.6
+
+   As of version 2.6, clicking the timer text or icon in the status bar will toggle its visibility.

docs/source/project_references.rst

@@ -0,0 +1,244 @@
+.. _a_references:
+
+*******************
+Tags and References
+*******************
+
+In novelWriter there are no forms or tables to fill in to define characters, locations or 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 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,
+   you can create a new project in the **Welcome** dialog's New project form and select "Create an
+   example project" from the "Pre-fill project" option. The example project contains several
+   examples of tags and references.
+
+
+.. _a_references_metadata:
+
+Metadata in novelWriter
+=======================
+
+The structure of your novelWriter project is inferred from the :term:`headings` within the
+documents, not the documents themselves. See :ref:`a_struct_heads` for more details. Therefore,
+metadata is also associated with headings, and not the documents directly.
+
+If you split your project into separate documents for each scene, this distinction may not matter.
+However, there are several benefits to using documents at a larger structural scale when first
+starting your project. For instance, it may make more sense to define all your scenes, and even
+chapters, in a single document at first, or perhaps a document per act. You can later split these
+documents up using the document split feature. See :ref:`a_ui_tree_split_merge` for more details.
+
+You can do the same with your notes. You can treat each heading as an independent element of your
+notes that can be referenced somewhere else. That way you can collect all your minor or background
+characters in a single note file, and still be able to reference them individually by separating
+them with headings and assigning each a tag. Or, you can lay out your plot in a single document and
+have a tag for each plot stage under separate headings.
+
+
+.. _a_references_tags:
+
+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 ``@tag`` :term:`keyword`.
+
+The basic format of a tag is ``@tag: tagName``.
+
+An alternative 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 directly into chapter headings. By default, the
+   ``tagName`` value is used in such 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.
+
+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 **Outline View** and in the references panel under the
+document viewer when a document is open 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
+to date. An invalid tag should have a green wiggly line under it, and will not receive the colour
+that valid tags do.
+
+The tag is the only part of these notes that novelWriter uses. The rest of the document content is
+there for you to use in whatever way you wish. Of course, the content of the documents can be added
+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 **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.
+
+.. versionadded:: 2.6
+
+   You can now add tags also to Novel Documents. These can be used for cross-referencing between
+   chapters and scenes, and also from notes if desired.
+
+Example of a heading with a tag for a character of the story:
+
+.. code-block:: md
+
+   # Character: Jane Doe
+
+   @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 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
+covered in the next section.
+
+
+.. _a_references_references:
+
+How to Use References
+=====================
+
+Each heading of any level in your project can contain references to tags set in project notes. The
+references are gathered by the indexer and used to generate the **Outline View**, among other
+things.
+
+References are set as a :term:`keyword` and a list of corresponding tags. The valid keywords are
+listed below. The format of a reference line is ``@keyword: value1, [value2] ... [valueN]``. All
+reference keywords allow multiple values.
+
+``@pov``
+   The point-of-view character for the current section. The target must be a note tag in a
+   **Character** type root folder.
+
+``@focus``
+   The character that has the focus for the current section. This can be used in cases where the
+   focus is not a point-of-view character. The target must be a note tag in a **Character** type
+   root folder.
+
+``@char``
+   Other characters in the current section. The target must be a note tag in a **Character** type
+   root folder. This should not include the point-of-view or focus character if those references
+   are used.
+
+``@plot``
+   The plot or subplot advanced in the current section. The target must be a note tag in a **Plot**
+   type root folder.
+
+``@time``
+   The timelines touched by the current section. The target must be a note tag in a **Timeline**
+   type root folder.
+
+``@location``
+   The location the current section takes place in. The target must be a note tag in a
+   **Locations** type root folder.
+
+``@object``
+   Objects present in the current section. The target must be a note tag in a **Object** type root
+   folder.
+
+``@entity``
+   Entities present in the current section. The target must be a note tag in an **Entities** type
+   root folder.
+
+``@custom``
+   Custom references in the current section. The target must be a note tag in a **Custom** type
+   root folder. The custom folder are for any other category of notes you may want to use.
+
+``@mention``
+   Anything mentioned, but not present in the current section. It is intended for those cases where
+   you reveal details about a character or place in a scene without it being otherwise a part of
+   it. This can be useful when checking for consistency later. Any tag in any root note folder can
+   be listed under mentions.
+
+``@story``
+   This is used when referencing a Novel Document, like a scene or chapter, from somewhere else in
+   your project.
+
+The syntax highlighter will alert the user that the tags and references are used correctly, and
+that the tags referenced exist.
+
+.. note::
+
+   The highlighter may be mistaken if the index of defined tags is out of date. If so, press
+   :kbd:`F9` to regenerate it, or select **Rebuild Index** from the **Tools** menu. In general, the
+   index for a document is regenerated when it is saved, so this shouldn't normally be necessary.
+
+.. tip::
+
+   If you add a reference in the editor to a tag that doesn't yet exist, you can right-click it and
+   select **Create Note for Tag**. This will generate a new project note automatically with the new
+   tag defined. In order for this to be possible, a root folder for that category of references
+   must already exist.
+
+One note can also reference another note in the same way novel documents do. When the note is
+opened in the document viewer, the references become clickable links, making it easier to follow
+connections in the plot. You can follow links in the document editor by clicking them with the
+mouse while holding down the :kbd:`Ctrl` key. Clicked links are always opened in the view panel.
+
+Project notes don't show up in the **Outline View**, so referencing between notes is only
+meaningful if you want to be able to click-navigate between them, or of course if you just want to
+highlight that two notes are related.
+
+.. tip::
+
+   If you cross-reference between notes and export your project as an HTML document using the
+   **Manuscript Build** tool, the cross-references become clickable links in the exported HTML
+   document as well.
+
+Example of a novel document with references to characters and plots:
+
+.. code-block:: md
+
+   ## Chapter 1
+
+   @pov: Jane
+
+   ### Scene 1
+
+   @char: John, Sam
+   @plot: Main
+
+   Once upon a time ...
+
+
+.. _a_references_completer:
+
+The References Auto-Completer
+-----------------------------
+
+An auto-completer context menu will show up automatically in the document editor when you type the
+character ``@`` on a new line. It will first suggest tag or reference keywords for you to add, and
+after the ``:`` has been added, suggest references from the list of tags you have already defined.
+
+You can use the auto-completer to add multiple references with a ``,`` between them, and even type
+new ones. New references can be created by right-clicking on them and selecting **Create Note for
+Tag** from the menu.
+
+.. versionadded:: 2.2

docs/source/project_structure.rst

@@ -4,10 +4,15 @@
 Novel Structure
 ***************
 
-This section covers the structure of a novel project.
+This chapter covers the structure of a novel project.
 
-It concerns documents under the :guilabel:`Novel` type root folder only. There are some
-restrictions and features that only apply to these types of documents.
+There are two different types of documents in a project, **Novel Documents** and **Project Notes**.
+Active novel documents can only live in a **Novel** type root folder. You can also move them to
+**Archive** and **Trash** of course, where they become inactive.
+
+The project tree can distinguish between the different heading levels of the novel documents using
+coloured icons, and optionally add emphasis on the label. Emphasis can be enabled in
+**Preferences**.
 
 
 .. _a_struct_heads:
@@ -16,51 +21,64 @@ Importance of Headings
 ======================
 
 Subfolders under root folders have no impact on the structure of the novel itself. The structure is
-instead dictated by the heading level of the headers within the documents.
+instead dictated by the heading level of the headings within the documents.
 
 Four levels of headings are supported, signified by the number of hashes (``#``) preceding the
-title. See also the :ref:`a_fmt` section for more details about the markdown syntax.
+title. See also the :ref:`a_fmt` section for more details about the markup syntax.
 
 .. note::
-   The header levels are not only important when generating the manuscript, they are also used by
-   the indexer when building the outline tree in the Outline as well as the Novel Tree. Each
-   heading also starts a new region where new references and tags can be defined.
 
-The syntax for the four basic header types, and the two special header types, is listed in section
+   The heading levels are not only important when generating the manuscript, they are also used by
+   the indexer when building the outline tree in the **Outline View** as well as in the **Novel
+   Tree**. Each heading also starts a new region where new Tags and References can be defined. See
+   :ref:`a_references` for more details.
+
+The syntax for the four basic heading types, and the three special types, is listed in section
 :ref:`a_fmt_head`. The meaning of the four levels for the structure of your novel is as follows:
 
-**Header Level 1: Partition**
-   This header level signifies that the text refers to a top level partition. This is useful when
+**Heading Level 1: Partition**
+   This heading level signifies that the text refers to a top level heading. This is useful when
    you want to split the manuscript up into books, parts, or acts. These headings are not required.
-   The novel title itself should use the special header level explained in :ref:`a_fmt_head`.
+   The novel title itself should use the special heading level ``#!`` covered in :ref:`a_fmt_head`.
 
-**Header Level 2: Chapter**
-   This header level signifies a chapter level partition. Each time you want to start a new
-   chapter, you must add such a heading. If you choose to split your manuscript up into one
-   document per scene, you need a single chapter document with just the heading. You can of course
-   also add a synopsis and reference keywords to the chapter document. If you want to open the
-   chapter with a quote or other introductory text that isn't part of a scene, this is also where
-   you'd put that text.
+**Heading Level 2: Chapter**
+   This heading level signifies a chapter. Each time you want to start a new chapter, you must add
+   such a heading. If you choose to split your manuscript up into one document per scene, you need
+   a single chapter document with just the heading. You can of course also add a synopsis and
+   reference keywords to the chapter document. If you want to open the chapter with a quote or
+   other introductory text that isn't part of a scene, this is also where you'd put that text.
 
-**Header Level 3: Scene**
-   This header level signifies a scene level partition. You must provide a title text, but the
-   title text can be replaced with a scene separator or just skipped entirely when you build your
-   manuscript.
+**Heading Level 3: Scene**
+   This heading level signifies a scene. You must provide a title text, but the title text can be
+   replaced with a scene separator or just skipped entirely when you build your manuscript. If you
+   need to distinguish between hard and soft scene breaks, there is an alternative format for
+   scenes you can use for this distinction. The formatting is covered in :ref:`a_fmt_head`. See
+   also :ref:`a_struct_heads_scenes`.
 
-**Header Level 4: Section**
-   This header level signifies a sub-scene level partition, usually called a "section" in the
-   documentation and the user interface. These can be useful if you want to change tag references
+**Heading Level 4: Section**
+   This heading level can be used to split up a scene, usually called a "section" in the
+   documentation and the user interface. These can be useful if you want to change references
    mid-scene, like if you change the point-of-view character. You are free to use sections as you
-   wish, and you can filter them out of the final manuscript just like with scene titles.
+   wish, and you can filter them out of the final manuscript.
 
-Page breaks are automatically added before level 1 and 2 headers when you build your project to a
-format that supports page breaks, or when you print the document directly from the build tool. If
+Page breaks can be automatically added before titles, partition, chapter and scene headings from
+the **Manuscript Build** tool when you build your project to a format that supports page breaks. If
 you want page breaks in other places, you have to specify them manually. See :ref:`a_fmt_break`.
 
 .. tip::
-   There are multiple options of how to process novel titles when building the manuscript. For
+
+   There are multiple options of how to process novel headings when building the manuscript. For
    instance, chapter numbers can be applied automatically, and so can scene numbers if you want
-   them in a draft manuscript. See the :ref:`a_export` page for more details.
+   them in a draft manuscript. You can also insert point-of-view character names in chapter titles.
+   See the :ref:`a_manuscript` page for more details.
+
+.. note::
+
+   As of 2.6, the heading levels internally in novelWriter do not map directly to heading levels in
+   manuscript documents. In manuscript documents, chapters are considered the top level heading,
+   and partitions become plain text paragraphs with a larger font.
+
+   .. versionadded:: 2.6
 
 
 .. _a_struct_heads_title:
@@ -68,18 +86,35 @@ you want page breaks in other places, you have to specify them manually. See :re
 Novel Title and Front Matter
 ----------------------------
 
-It is recommended that you add a document at the very top of each Novel root folder with the novel
-title as the first line. You should modify the level 1 header format code with an ``!`` in order to
+It is recommended that you add a document at the very top of each **Novel** root folder with the
+novel title in it. You should modify the level 1 heading format code with an ``!`` in order to
 render it as a document title that is excluded from any automatic Table of Content in a manuscript
-build document, like so:
+build document.
 
-``#! My Novel``
+You can also add the author name and address above this if this is required by the manuscript
+format you use, and additional space added before the title.
+
+This is the title page novelWriter generates automatically for a new project as of version 2.6:
+
+.. code-block:: md
+
+   Jane Doe[br]
+   Address 1[br]
+   Address 2 <<
+
+   [vspace:5]
+
+   #! My Novel
+
+   >> **By Jane Doe** <<
+
+   >> Word Count: [field:textWords] <<
 
 The title is by default centred on the page. You can add more text to the page as you wish, like
 for instance the author's name and details.
 
 If you want an additional page of text after the title page, starting on a fresh page, you can add
-``[NEW PAGE]`` on a line by itself, and continue the text after it. This will insert a page break
+``[new page]`` on a line by itself, and continue the text after it. This will insert a page break
 before the text. See also :ref:`a_fmt_break`.
 
 
@@ -89,120 +124,40 @@ Unnumbered Chapter Headings
 ---------------------------
 
 If you use the automatic numbering feature for your chapters, but you want to keep some special
-chapters separate from this, you cam add a ``!`` to the level 2 header formatting code to tell the
-build tool to skip these chapters.
+chapters separate from this, you can add an ``!`` to the level 2 heading formatting code to tell
+the build tool to skip these chapters when adding numbers.
 
-``##! Unnumbered Chapter Title``
+.. code-block:: md
 
-There is a separate formatting feature for such chapters in the :guilabel:`Build Novel Project`
-tool as well. See the :ref:`a_export` page for more details. When building a document of a format
-that supports page breaks, also unnumbered chapters will have a page break added just like for
-normal chapters.
+   ##! Unnumbered Chapter Title
 
-.. Note::
-   Previously, you could also disable the automatic numbering of a chapter by adding an ``*`` as
-   the first character of the chapter title itself. This feature has been dropped in favour of the
-   current format in order to keep level 1 and 2 headers consistent. Please update your chapter
-   headings if you've used this syntax.
+   Chapter Text
+
+There is a separate formatting feature for such chapter titles in the **Manuscript Build** tool as
+well. See the :ref:`a_manuscript` page for more details. When building a document of a format that
+supports page breaks, also unnumbered chapters can have a page break added just like for normal
+chapters.
 
 
-.. _a_struct_tags:
+.. _a_struct_heads_scenes:
 
-Note References
-===============
+Hard and Soft Scene Breaks
+--------------------------
 
-Each text partition, indicated by a heading of any level, can contain references to tags set in the
-project notes of the project. The references are gathered by the indexer and used to generate the
-Outline View. This section covers how to make references to tags. See :ref:`a_notes_tags` for how
-to define tags the references can point to.
+If you need two different ways to style scenes in your manuscript, like if you want to insert
+different scene separators for soft and hard scene breaks, there is an alternative scene format
+available for scene headings with a ``!`` added to the formatting code.
 
-References and tags are also clickable in the document editor and viewer, making it easy to
-navigate between reference notes while writing. Clicked links are always opened in the view panel.
+.. code-block:: md
 
-References are set as a keyword and a list of corresponding tags. The valid keywords are listed
-below. The format of a reference line is ``@keyword: value1, [value2] ... [valueN]``. All keywords
-allow multiple values.
+   ### Soft Scene Transition
 
-``@pov``
-   The point-of-view character for the current section. The target must be a note tag in a
-   :guilabel:`Character` type root folder.
+   A soft scene break.
 
-``@focus``
-   The character that has the focus for the current section. This can be used in cases where the
-   focus is not a point-of-view character. The target must be a note tag in a :guilabel:`Character`
-   type root folder.
+   ###! Hard Scene Transition
 
-``@char``
-   Other characters in the current section. The target must be a note tag in a
-   :guilabel:`Character` type root folder. This should not include the point-of-view or focus
-   character if those references are used.
+   A hard scene break.
 
-``@plot``
-   The plot or subplot advanced in the current section. The target must be a note tag in a
-   :guilabel:`Plot` type root folder.
+There is a separate formatting feature for these titles in the **Manuscript Build** tool.
 
-``@time``
-   The timelines touched by the current section. The target must be a note tag in a
-   :guilabel:`Timeline` type root folder.
-
-``@location``
-   The location the current section takes place in. The target must be a note tag in a
-   :guilabel:`Locations` type root folder.
-
-``@object``
-   Objects present in the current section. The target must be a note tag in a :guilabel:`Object`
-   type root folder.
-
-``@entity``
-   Entities present in the current section. The target must be a note tag in a
-   :guilabel:`Entities` type root folder.
-
-``@custom``
-   Custom references in the current section. The target must be a note tag in a :guilabel:`Custom`
-   type root folder. The custom folder are for any other category of notes you may want to use.
-
-The syntax highlighter will alert the user that the tags and references are used correctly, and
-that the tags referenced exist.
-
-The highlighter may be mistaken if the index of defined tags is out of date. If so, press :kbd:`F9`
-to regenerate it, or select :guilabel:`Rebuild Index` from the :guilabel:`Tools` menu. In general,
-the index for a document is regenerated when it is saved, so this shouldn't normally be necessary.
-
-Example of a novel document with references to characters and plots:
-
-.. code-block:: none
-   :linenos:
-
-   ## Chapter 1
-
-   @pov: Jane
-
-   ### Scene 1
-
-   @char: John, Sam
-   @plot: Main
-
-   Once upon a time ...
-
-
-.. _a_struct_layout:
-
-Document Layout
-===============
-
-All documents in the project can have a layout format set. Previously, there were multiple layouts
-available to change how the documents where formatted on export. These have now been reduced to
-just two layouts: :guilabel:`Novel Document` and :guilabel:`Project Note`.
-
-Novel documents can only live in a :guilabel:`Novel` type root folder. You can also move them to
-:guilabel:`Archive` and :guilabel:`Trash` of course. Project notes can be added anywhere in the
-project.
-
-The project tree can distinguish between the different layouts and header levels of the documents
-using coloured icons, and optionally add emphasis on the label (See the :guilabel:`Preferences`.)
-For novel documents, the heading level of the first heading is recorded, and indicated by the icon.
-
-.. tip::
-   You can always start writing with a coarse setup with one or a few documents, and then later use
-   the split tool to split the documents into separate chapter and scene documents. You can split a
-   document on any of the four header levels.
+.. versionadded:: 2.4

docs/source/requirements.txt

@@ -1,4 +1,6 @@
-furo
-sphinx>=4.0
+sphinx-book-theme
+sphinx>=5.0
+sphinx-favicon
+sphinx-design
 pygments>=2.7
-docutils==0.17.1
+docutils>=0.17.1

docs/source/tech_locations.rst

@@ -7,7 +7,7 @@ File Locations
 .. _QStandardPaths: https://doc.qt.io/qt-5/qstandardpaths.html
 
 novelWriter will create a few files on your system outside of the application folder itself. These
-file locations are described in this document.
+file locations are described in this chapter.
 
 
 .. _a_locations_conf:
@@ -15,17 +15,17 @@ file locations are described in this document.
 Configuration
 =============
 
-The general configuration of novelWriter, including everything that is in :guilabel:`Preferences`,
-is saved in one central configuration file. The location of this file depends on your operating
-system. The system paths are provided by the Qt QStandardPaths_ class and its ConfigLocation value.
+The general configuration of novelWriter, including everything that is in **Preferences**, is saved
+in one central configuration file. The location of this file depends on your operating system. The
+system paths are provided by the Qt QStandardPaths_ class and its ``ConfigLocation`` value.
 
 The standard paths are:
 
 * Linux: ``~/.config/novelwriter/novelwriter.conf``
-* macOS: ``~/Library/Preferences/novelwriter/novelwriter.conf``
+* MacOS: ``~/Library/Preferences/novelwriter/novelwriter.conf``
 * Windows: ``C:\Users\<USER>\AppData\Local\novelwriter\novelwriter.conf``
-   
-Here, ``~`` corresponds to the user's home directory on Linux and macOS, and ``<USER>`` is the
+
+Here, ``~`` corresponds to the user's home directory on Linux and MacOS, and ``<USER>`` is the
 user's username on Windows.
 
 .. note::
@@ -39,18 +39,27 @@ Application Data
 ================
 
 novelWriter also stores a bit of data that is generated by the user's actions. This includes the
-list of recent projects form the :guilabel:`Open Project` dialog. Custom themes should also be
-saved here. The system paths are provided by the Qt QStandardPaths_ class and its AppDataLocation.
+list of recent projects form the **Welcome** dialog. Custom themes should also be saved here. The
+system paths are provided by the Qt QStandardPaths_ class and its ``AppDataLocation`` value.
 
 The standard paths are:
 
 * Linux: ``~/.local/share/novelwriter/``
-* macOS: ``~/Library/Application Support/novelwriter/``
+* MacOS: ``~/Library/Application Support/novelwriter/``
 * Windows: ``C:\Users\<USER>\AppData\Roaming\novelwriter\``
-   
-Here, ``~`` corresponds to the user's home directory on Linux and macOS, and ``<USER>`` is the
+
+Here, ``~`` corresponds to the user's home directory on Linux and MacOS, and ``<USER>`` is the
 user's username on Windows.
 
 .. note::
    These are the standard operating system defined locations. If your system has been set up in a
    different way, these locations may also be different.
+
+The Application Data location also holds several folders:
+
+``cache``
+   This folder is used to save the preview data for the **Manuscript Build** tool.
+
+``icons``, ``syntax`` and ``themes``
+   These folders are empty by default, but this is where the user can store custom theme files.
+   See :ref:`a_custom` for more details.

docs/source/tech_source.rst

@@ -4,18 +4,25 @@
 Running from Source
 *******************
 
-.. _main website: https://novelwriter.io
 .. _GitHub: https://github.com/vkbo/novelWriter/releases
 .. _PyPi: https://pypi.org/project/novelWriter/
 .. _Sphinx Docs: https://www.sphinx-doc.org/
 
-This section describes various ways of running novelWriter directly from the source code, and how
+This chapter describes various ways of running novelWriter directly from the source code, and how
 to build the various components like the translation files and documentation.
 
 .. note::
    The text below assumes the command ``python`` corresponds to a Python 3 executable. Python 2 is
-   now deprecated, but many systems still have both Python 2 and 3. For such systems, the command
-   ``python3`` may be needed instead. Likewise, ``pip`` may need to be replaced with ``pip3``.
+   now deprecated, but on many systems the command ``python3`` may be needed instead. Likewise,
+   ``pip`` may need to be replaced with ``pip3``.
+
+Most of the custom commands for building packages of novelWriter, or building assets, are contained
+in the ``pkgutils.py`` script in the root of the source code. You can list the available commands
+by running:
+
+.. code-block:: bash
+
+   python pkgutils.py help
 
 
 .. _a_source_depend:
@@ -23,23 +30,18 @@ to build the various components like the translation files and documentation.
 Dependencies
 ============
 
-novelWriter has been designed to rely on as few dependencies as possible. Aside from the packages
-needed to communicate with the Qt GUI libraries, only one package is required for handling the XML
-format of the main project file. Everything else is handled with standard Python libraries.
+novelWriter has been designed to rely on as few dependencies as possible. Only the Python wrapper
+for the Qt GUI libraries is required. The package for spell checking is optional, but recommended.
+Everything else is handled with standard Python libraries.
 
-The following Python packages are needed to run novelWriter:
+The following Python packages are needed to run all features of novelWriter:
 
 * ``PyQt5`` – needed for connecting with the Qt5 libraries.
-* ``lxml`` – needed for full XML support.
 * ``PyEnchant`` – needed for spell checking (optional).
 
-PyQt/Qt should be at least 5.10, but ideally 5.13 or higher for all features to work. For instance,
-searching using regular expressions with full Unicode support requires 5.13. There is no known
-minimum version requirement for package ``lxml``, but the code was originally written with 4.2,
-which is therefore set as the minimum. It may work on lower versions. You have to test it.
-
-If you want spell checking, you must install the ``PyEnchant`` package. The spell check library
-must be at least 3.0 to work with Windows. On Linux, 2.0 also works fine.
+PyQt/Qt must be at least 5.15.0. If you want spell checking, you must install the ``PyEnchant``
+package. The spell check library must be at least 3.0 to work with Windows. On Linux, 2.0 also
+works fine.
 
 If you install from PyPi, these dependencies should be installed automatically. If you install from
 source, dependencies can still be installed from PyPi with:
@@ -48,40 +50,44 @@ source, dependencies can still be installed from PyPi with:
 
    pip install -r requirements.txt
 
+.. note::
+   On Linux distros, the Qt library is usually split up into multiple packages. In some cases,
+   secondary dependencies may not be installed automatically. For novelWriter, the library files
+   for rendering the SVG icons may be left out and needs to be installed manually. This is the
+   case on for instance Arch Linux.
+
 
 .. _a_source_install:
 
-Install from Source
-===================
+Build and Install from Source
+=============================
 
-You can download the latest version of novelWriter from the source repository on GitHub_ and run
-the setup manually. It is equivalent to what the ``pip install`` command does, and it installs
-novelWriter to the default location for Python packages.
-
-This step requires that you have ``setuptools`` installed on your system. If you don't have it
-installed, it can usually be installed from your distro's repository. For Debian and Ubuntu this is
-achieved with:
+If you want to install novelWriter directly from the source available on GitHub_, you must first
+build the package using the Python Packaging Authority's build tool. It can be installed with:
 
 .. code-block:: bash
 
-   sudo apt install python3-setuptools
+   pip install build
 
-The package is also available from PyPi:
+On Debian-based systems the tool can also be installed with:
 
 .. code-block:: bash
 
-   pip install --user setuptools
+   sudo apt install python3-build
 
-With ``setuptools`` in place, novelWriter can be installed to the user space with:
+With the tool installed, run the following command from the root of the novelWriter source code:
 
 .. code-block:: bash
 
-   python setup.py install --user
+   python -m build --wheel
 
-.. tip::
+This should generate a ``.whl`` file in the ``dist/`` folder at your current location. The wheel
+file can then be installed on your system. Here with example version number 2.0.7, but yours may be
+different:
 
-   The main setup script has a number of options that may be useful to you. You can list them by
-   running ``python setup.py help``.
+.. code-block:: bash
+
+   pip install --user dist/novelWriter-2.0.7-py3-none-any.whl
 
 
 .. _a_source_i18n:
@@ -98,7 +104,7 @@ You can build the ``.qm`` files with:
 
 .. code-block:: bash
 
-   python setup.py qtlrelease
+   python pkgutils.py qtlrelease
 
 This requires that the Qt Linguist tool is installed on your system. On Ubuntu and Debian, the
 needed package is called ``qttools5-dev-tools``.
@@ -115,11 +121,12 @@ Building the Example Project
 ============================
 
 In order to be able to create new projects from example files, you need a ``sample.zip`` file in
-the ``assets`` folder of the source. This file can be built from setup script by running:
+the ``assets`` folder of the source. This file can be built from the ``pkgutils.py`` script by
+running:
 
 .. code-block:: bash
 
-   python setup.py sample
+   python pkgutils.py sample
 
 
 .. _a_source_docs:
@@ -127,12 +134,12 @@ the ``assets`` folder of the source. This file can be built from setup script by
 Building the Documentation
 ==========================
 
-A local copy of this documentation can be generated as HTML. This requires the following Python
+A local copy of this documentation can be generated as HTML. This requires installing some Python
 packages from PyPi:
 
 .. code-block:: bash
 
-   pip install furo sphinx
+   pip install -r docs/source/requirements.txt
 
 The documentation can then be built from the root folder in the source code by running:
 
@@ -143,13 +150,12 @@ The documentation can then be built from the root folder in the source code by r
 If successful, the documentation should be available in the ``docs/build/html`` folder and you can
 open the ``index.html`` file in your browser.
 
-You can also build a PDF manual from the documentation using the setup script:
+You can also build a PDF manual from the documentation using the ``pkgutils.py`` script:
 
 .. code-block:: bash
 
-   python setup.py manual
+   python pkgutils.py manual
 
 This will build the documentation as a PDF using LaTeX. The file will then be copied into the
-assets folder and made available in the :guilabel:`Help` menu in novelWriter. The Sphinx build
-system has a few extra dependencies when building the PDF. Please check the `Sphinx Docs`_ for more
-details.
+assets folder and made available in the **Help** menu in novelWriter. The Sphinx build system has a
+few extra dependencies when building the PDF. Please check the `Sphinx Docs`_ for more details.

docs/source/tech_storage.rst

@@ -4,7 +4,9 @@
 How Data is Stored
 ******************
 
-This section contains details of how novelWriter stores and handles the project data.
+.. _documentation: https://docs.novelwriter.io/
+
+This chapter contains details of how novelWriter stores and handles the project data.
 
 
 Project Structure
@@ -21,56 +23,61 @@ Main Project File
 -----------------
 
 The project itself requires a dedicated folder for storing its files, where novelWriter will create
-its own "file system" where the folder and file hierarchy is described in a project XML file. This
-is the main project file in the project's root folder with the name ``nwProject.nwx``. This file
-also contains all the meta data required for the project, and a number of related project settings.
+its own "file system" where the project's folder and file hierarchy is described in a project XML
+file. This is the main project file in the project's root folder with the name ``nwProject.nwx``.
+This file also contains all the meta data required for the project (except the index data), and a
+number of related project settings.
 
 If this file is lost or corrupted, the structure of the project is lost, although not the text
 itself. It is important to keep this file backed up, either through the built-in backup tool, or
 your own backup solution.
 
-.. tip::
-   The novelWriter project folder is structured so that it can easily be added to a version control
-   system like git. If you do so, you may want to add a `.gitignore` file to exclude files with the
-   extensions `.json` as JSON files are used to cache the index and various run-time settings and
-   are generally large files that change often.
-
 The project XML file is indent-formatted, and is suitable for diff tools and version control since
-most of the file will stay static, although a timesetamp is set in the meta section on line 2, and
+most of the file will stay static, although a timestamp is set in the meta section on line 2, and
 various meta data entries incremented, on each save.
 
+.. only:: not html
+
+   A full project file format specification is available in the online documentation_.
+
+.. only:: html
+
+   A full description of the current file format is available in the
+   :download:`File Format Spec 1.5 <fileformatspec15.pdf>` document, available as a PDF.
+
 
 Project Documents
 =================
 
-All the project documents are saved in a folder in the main project folder named ``content``. Each
-document has a file handle based on a 52 bit random number, represented as a hexadecimal string.
-The documents are saved with a filename assembled from this handle and the file extension ``.nwd``.
+All the project documents are saved in a subfolder of the main project folder named ``content``.
+Each document has a file handle based on a 52 bit random number, represented as a hexadecimal
+string. The documents are saved with a filename assembled from this handle and the file extension
+``.nwd``.
 
 If you wish to find the file system location of a document in the project, you can either look it
-up in the project XML file, select :guilabel:`Show File Details` from the :guilabel:`Document` menu
-when having the document open, or look in the ``ToC.txt`` file in the root of the project folder.
-The ``ToC.txt`` file has a list of all documents in the project, referenced by their label, and
-where they are saved.
+up in the project XML file, select **Show File Details** from the **Document** menu when having the
+document open in the editor, or look in the ``ToC.txt`` file in the root of the project folder. The
+``ToC.txt`` file has a list of all documents in the project, referenced by their label, and where
+they are saved.
 
 The reason for this cryptic file naming is to avoid issues with file naming conventions and
 restrictions on different operating systems, and also to have a file name that does not depend on
-what the user names the document within the project, or changes it to. This is particularly useful
-when using a versioning system.
+what you name the document within the project, or changes it to. This is particularly useful when
+using a versioning system.
 
 Each document file contains a plain text version of the text from the editor. The file can in
 principle be edited in any text editor, and is suitable for diffing and version control if so
 desired. Just make sure the file remains in utf-8 encoding, otherwise unicode characters may
 become mangled when the file is opened in novelWriter again.
 
-Editing these files is generally not recommended outside of special circumstances, whatever they
-may be. The reason for this is that the index will not be automatically updated when doing so,
-which means novelWriter doesn't know you've altered the file. If you do edit a file in this manner,
-you should rebuild the index when you next open the project in novelWriter.
+Editing these files is generally not recommended. The reason for this is that the index will not be
+automatically updated when doing so, which means novelWriter doesn't know you've altered the file.
+If you *do* edit a file in this manner, you should rebuild the index when you next open the project
+in novelWriter.
 
 The first lines of the file may contain some meta data starting with the characters ``%%~``. These
-lines are mainly there to restore some information if it is lost from the project file, and the
-information may be helpful if you do open the file in an external editor as it contains the
+lines are mainly there to restore some information if the file is lost from the main project file,
+and the information may be helpful if you do open the file in an external editor as it contains the
 document label and the document class and layout. The lines can be deleted without any consequences
 to the rest of the content of the file, and will be added back the next time the document is saved
 in novelWriter.
@@ -80,14 +87,9 @@ The File Saving Process
 -----------------------
 
 When saving the project file, or any of the documents, the data is first saved to a temporary file.
-If successful, the old data file is then removed, and the temporary file becomes the new file. This
-ensures that the previously saved data is only replaced when the new data has been successfully
-saved to the storage medium.
-
-For the project XML file, a ``.bak`` file is in addition kept, which will always contain the
-previous version of the file, although when auto-save is enabled, they may have the same content.
-If the opening of a project file fails, novelWriter will automatically try to open the ``.bak``
-file instead.
+If successful, the old data file is then removed, and the temporary file replaces it. This ensures
+that the previously saved data is only replaced when the new data has been successfully saved to
+the storage medium.
 
 
 Project Meta Data
@@ -95,19 +97,19 @@ Project Meta Data
 
 The project folder contains a subfolder named ``meta``, containing a number of files. The meta
 folder contains semi-important files. That is, they can be lost with only minor impact to the
-project.
+project. All files in this folder are JSON or JSON Lines files, although some other files may
+remain from earlier versions of novelWriter as they haven't all been JSON files in the past.
 
 If you use version control software on your project, you can exclude this folder, although you may
-want to track the session log file and the custom words list. The JSON files within this folder can
-safely be ignored as they will be automatically regenerated if lost.
+want to track the session log file and the custom words list.
 
 
 The Project Index
 -----------------
 
-Between writing sessions, the project index is saved in a JSON file in ``meta/tagsIndex.json``.
-This file is not critical. If it is lost, it can be rebuilt from within novelWriter from the
-:guilabel:`Tools` menu.
+Between writing sessions, the project index is saved in a JSON file in ``meta/index.json``.
+This file is not critical. If it is lost, it can be completely rebuilt from within novelWriter from
+the **Tools** menu.
 
 The index is maintained and updated whenever a document or note is saved in the editor. It contains
 all references and tags in documents and notes, as well as the location of all headers in the
@@ -120,10 +122,17 @@ check somehow fails and novelWriter keeps crashing, you can delete the file manu
 the index. If this too fails, you have likely encountered a bug.
 
 
+Build Definitions
+-----------------
+
+The build definitions from the **Manuscript Build** tool are kept in the ``meta/builds.json`` file.
+If this file is lost, all custom build definitions are lost too.
+
+
 Cached GUI Options
 ------------------
 
-A file named ``meta/guiOptions.json`` contains the latest state of various GUI buttons, switches,
+A file named ``meta/options.json`` contains the latest state of various GUI buttons, switches,
 dialog window sizes, column sizes, etc, from the GUI. These are the GUI settings that are specific
 to the project. Global GUI settings are stored in the main config file.
 
@@ -134,26 +143,18 @@ settings.
 Custom Word List
 ----------------
 
-A file named ``meta/wordlist.txt`` contains all the custom words you've added to the project for
-spell checking purposes. The content of the file can be edited from the :guilabel:`Tools` menu. If
-you lose this file, all your custom spell check words will be lost too.
+A file named ``meta/userdict.json`` contains all the custom words you've added to the project for
+spell checking purposes. The content of the file can be edited from the **Tools** menu. If you lose
+this file, all your custom spell check words will be lost too.
 
 
 Session Stats
 -------------
 
-The writing progress is saved in the ``meta/sessionStats.log`` file. This file records the length
-and word counts of each writing session on the given project. The file is used by the
-:guilabel:`Writing Statistics` tool. If this file is lost, the history it contains is also lost,
-but it has otherwise no impact on the project.
+The writing progress is saved in the ``meta/sessions.jsonl`` file. This file records the length
+and word counts of each writing session on the given project. The file is used by the **Writing
+Statistics** tool. If this file is lost, the history it contains is also lost, but it has otherwise
+no impact on the project.
 
-
-Project Cache
-=============
-
-The project ``cache`` folder contains non-critical files. If these files are lost, there is no
-impact on the functionality of novelWriter or the history of the project. It contains temporary
-files, like the preview document in the :guilabel:`Build Novel Project` tool.
-
-It should be excluded from version control tools if such are used. The folder will be removed
-entirely in novelWriter 2.1.
+Each session is recorded as a JSON object on a single line of the file. Each session record is
+appended tot he file.

docs/source/tech_tests.rst

@@ -15,7 +15,7 @@ The dependencies for running the tests can be installed with:
 
 .. code-block:: bash
 
-   pip install -r requirements-dev.txt
+   pip install -r tests/requirements.txt
 
 This will install a couple of extra packages for coverage and test management. The minimum
 requirement is ``pytest`` and ``pytest-qt``.
@@ -34,12 +34,11 @@ Since several of the tests involve opening up the novelWriter GUI, you may want
 for the duration of the test run. Moving your mouse while the tests are running may otherwise
 interfere with the execution of some tests.
 
-You can disable the renderring of the GUI by setting the flag ``export QT_QPA_PLATFORM=offscreen``,
-or alternatively run the tests with the ``xvfb`` package, like so:
+You can disable the renderring of the GUI by setting the flag ``QT_QPA_PLATFORM=offscreen``:
 
 .. code-block:: bash
 
-   xvfb-run pytest
+   export QT_QPA_PLATFORM=offscreen pytest
 
 
 Advanced Options
@@ -51,7 +50,7 @@ You can also add coverage report generation. For instance to HTML:
 
 .. code-block:: bash
 
-   xvfb-run pytest -v --cov=novelwriter --cov-report=html
+   export QT_QPA_PLATFORM=offscreen pytest -v --cov=novelwriter --cov-report=html
 
 Other useful report formats are ``xml``, and ``term`` for terminal output.
 
@@ -60,7 +59,7 @@ subpackage groups are ``base``, ``core``, and ``gui``. Consider for instance:
 
 .. code-block:: bash
 
-   xvfb-run pytest -v --cov=novelwriter --cov-report=html -m core
+   export QT_QPA_PLATFORM=offscreen pytest -v --cov=novelwriter --cov-report=html -m core
 
 This will only run the tests of the "core" package, that is, all the classes that deal with the
 project data of a novelWriter project. The "gui" tests, likewise, will run the tests for the GUI
@@ -71,7 +70,7 @@ You can also filter the tests with the ``-k`` switch. The following will do the
 
 .. code-block:: bash
 
-   xvfb-run pytest -v --cov=novelwriter --cov-report=html -k testCore
+   export QT_QPA_PLATFORM=offscreen pytest -v --cov=novelwriter --cov-report=html -k testCore
 
 All tests are named in such a way that you can filter them by adding more bits of the test names.
 They all start with the word "test". Then comes the group: "Core", "Base", "Dlg", "Tool", or "Gui".
@@ -80,6 +79,6 @@ file. For instance, running the following will run all tests for the document ed
 
 .. code-block:: bash
 
-   xvfb-run pytest -v --cov=novelwriter --cov-report=html -k testGuiEditor
+   export QT_QPA_PLATFORM=offscreen pytest -v --cov=novelwriter --cov-report=html -k testGuiEditor
 
 To run a single test, simply add the full test name to the ``-k`` switch.

docs/source/usage_breakdown.rst

@@ -6,12 +6,13 @@ How it Works
 
 .. _Fusion: https://doc.qt.io/qt-6/gallery.html
 .. _Pandoc: https://pandoc.org/
-.. _Typicons: https://github.com/stephenhutchings/typicons.font
 .. _Open Document: https://en.wikipedia.org/wiki/OpenDocument
+.. _Office Open XML: https://en.wikipedia.org/wiki/Office_Open_XML
+.. _version control: https://en.wikipedia.org/wiki/Version_control
 
-The main features of novelWriter are listed in the :ref:`a_intro` section. Here, we go into some
-more details on how they are implemented. This is intended as an overview. Later on in this
-documentation, these features will be covered in even more detail.
+The main features of novelWriter are listed in the :ref:`a_intro` chapter. In this chapter, we go
+into some more details on how they are implemented. This is intended as an overview. Later on in
+this documentation these features will be covered in more detail.
 
 
 .. _a_breakdown_design:
@@ -20,155 +21,230 @@ GUI Layout and Design
 =====================
 
 The user interface of novelWriter is intended to be as minimalistic as practically possible, while
-at the same time provide a complete set of features needed for writing a novel.
+at the same time provide useful features needed for writing a novel.
 
-The main window does not have an editor toolbar like many other applications do. This reduces
-clutter, and since the documents are formatted with style tags, is more or less redundant. However,
-most formatting features supported are available through convenient keyboard shortcuts. They are
-also available in the main menu so you don't have to look up formatting codes every time you need
-them. For reference, a list of all shortcuts can be found in the :ref:`a_kb` section.
+The main window does not by default have an editor toolbar like many other applications do. This
+reduces clutter, and since the documents are formatted with style tags, it is not needed most of
+the time. Still, a small formatting toolbar can be popped out by clicking the left-most button in
+the header of the document editor. It gives quick access to standard formatting codes.
+
+Most formatting features supported are available through convenient keyboard shortcuts. They are
+also available in the main menu under **Format**, so you don't have to look up formatting codes
+every time you need them. For reference, a list of all shortcuts can be found in the :ref:`a_kb`
+chapter.
 
 .. note::
    novelWriter is not intended to be a full office type word processor. It doesn't support images,
    links, tables, and other complex structures and objects often needed for such documents.
-   Formatting is limited to headers, emphasis, text alignment, and a few other simple features.
+   Formatting is limited to headings, in-line basic text formats, text alignment, and a few other
+   simple features.
 
-On the left edge of the main window, you will find a sidebar. This bar has buttons for the standard
-views you can switch between, a quick link to the :guilabel:`Build Novel Project` tool, and a set
-of project-related tools as well as quick access to settings at the bottom.
+On the left side of the main window, you will find a sidebar. This bar has buttons for the standard
+views you can switch between, a quick link to the **Build Manuscript** tool, and a set of
+project-related tools and quick access to settings at the bottom.
+
+.. versionadded:: 2.2
+
+   A number of new formatting options were added in 2.2 to allow for some special formatting cases.
+   At the same time, a small formatting toolbar was added to the editor. It is hidden by default,
+   but can be opened by pressing the button in the top--left corner of the editor header.
 
 
-Project Tree View
------------------
+Project Tree and Editor View
+----------------------------
 
-When in :guilabel:`Project Tree View` mode, the main work area of the main window is split in two,
-or optionally three, panels. The left-most panel contains the project tree and all the documents in
-your project. The second panel is the document editor. An optional third panel on the right is a
-document viewer which can view any document in your project independently of what is open in the
-document editor. This panel is not intended as a preview window, although you can use it for this
-if you wish as it will apply the formatting tags you have specified. The main purpose of the viewer
-is for viewing your notes next to your editor while you're writing.
+.. figure:: images/fig_project_tree_view.png
 
-The editor also has a :guilabel:`Focus Mode` you can toggle either from the menu, from the icon in
-the editor header, or by pressing :kbd:`F8`. When :guilabel:`Focus Mode` is enabled, all the user
-interface elements other than the document editor itself are hidden away.
+   A screenshot of the Project Tree and Editor View.
+
+When the application is in **Project Tree View** mode, the work area of the main window is split in
+two, or optionally three, panels. The left-most panel contains the project tree and all the
+documents in your project. The second panel is the document editor.
+
+An optional third panel on the right side contains a document viewer which can view any document in
+your project independently of what is open in the document editor. This panel is not intended as a
+preview window, although you can use it for this purpose if you wish. For instance if you need to
+check that the formatting tags behave as you expect. However, the main purpose of the viewer is for
+viewing your notes next to your editor while you're writing.
+
+The editor also has a **Focus Mode** you can toggle either from the menu, from the icon in the
+editor's header, or by pressing :kbd:`F8`. When **Focus Mode** is enabled, all the user interface
+elements other than the document editor itself are hidden away.
+
+The project tree will highlight with a different background colour the document that is currently
+open in the editor.
+
+.. versionadded:: 2.6
+
+   You can now drag and drop documents from the project tree onto the editor or viewer panels to
+   open them.
 
 
-Novel Tree View
----------------
+Novel View and Editor View
+--------------------------
 
-When in :guilabel:`Novel Tree View` mode, the project tree is replaces by an overview of your novel
-structure. Instead of showing individual documents, the tree now shows all headings of your novel
-text. This includes multiple headings within the same document.
+.. figure:: images/fig_novel_tree_view.png
 
-Each heading is indented according to the heading level. You can open and edit your novel documents
-from this view as well. All headings contained in the currently open document should be highlighted
-in the view to indicate which ones belong together.
+   A screenshot of the Novel Tree and Editor View.
 
-If you have multiple Novel root folders, the header of the novel view becomes a droopdown box. You
-can then switch between them by clicking the "Outline of ..." text. You can also click the novel
-icon button next to it.
+When the application is in **Novel Tree View** mode, the project tree is replaced by an overview of
+your novel structure for a specific Novel :term:`root folder`. Instead of showing individual
+documents, the tree now shows all headings of your novel text. This includes multiple headings
+within the same document.
+
+Each heading is indented according to the heading level, not its parent/child relationship to other
+elements of your project. You can open and edit your novel documents from this view as well. All
+headings contained in the currently open document should be highlighted in the view to indicate
+which ones belong together in the same document.
+
+If you have multiple **Novel** type root folders, the header of the novel view becomes a dropdown
+box. You can then switch between them by clicking the :guilabel:`Outline of ...` text. You can also
+click the novel icon button next to it.
 
 Generally, the novel view should update when you make changes to the novel structure, including
 edits of the current document in the editor. The information is only updated when the automatic
-save of the document is initiated though. You can adjust the aut-save interval in
-:guilabel:`Preferences`. You can also regenerate the whole novel view by pressing the refresh
-button at the top.
+save of the document is triggered, or you manually press :kbd:`Ctrl+S` to save changes. (You can
+adjust the auto-save interval in **Preferences**.) You can also regenerate the whole novel view by
+pressing the refresh button in the novel view header.
 
-It is possible to show an optional third column in the novel view, The settings are available from
-the menu button ath the top.
+It is possible to show an optional third column in the novel view. The settings are available from
+the menu button in the toolbar.
 
-If you click the arrow icon to the right of each item, a tooltip will pop up showing you all the
-meta data collected for that heading entry.
+If you click the triangular icon to the right of each item, a tooltip will pop out showing all the
+meta data collected for that heading.
 
 
 Novel Outline View
 ------------------
 
-When in :guilabel:`Novel Outline View` mode, the tree, editor and viewer will be replaced by a
-large table that shows the entire novel structure with all the tags and references listed. Pretty
+.. figure:: images/fig_outline_view.png
+
+   A screenshot of the Novel Outline View.
+
+When the application is in **Novel Outline View** mode, the tree, editor and viewer are replaced by
+a large table that shows the entire novel structure with all the tags and references listed. Pretty
 much all collected meta data is available here in different columns.
 
 You can select which novel root folder to display from the dropdown box, and you can select which
 columns to show or hide from the menu button. You can also rearrange the columns by drag and drop.
-The app will remember you column order and size between sessions, and for each individual project.
+The app remembers your column order and sizes between sessions, and for each individual project.
 
 
 Colour Themes
 -------------
 
-The default colour theme of the user interface is the default theme from the Qt library. By
-default, novelWriter is loaded with the Fusion_ style setting. (You can override this with the
-``--style=`` setting when starting novelWriter.)
+By default, novelWriter uses a light colour theme. You can also choose between a standard dark
+theme that have neutral colours, or a series of other included themes, from **Preferences**. 
 
-There is a standard dark theme provided as well, which is similar to the default Qt theme. Some
-other light and dark colour themes are also provided. You can select which one you prefer from in
-:guilabel:`Preferences` .
+If you wish, you *can* create your own colour themes, and even have them added to the application.
+See :ref:`a_custom_theme` for more details.
 
-A number of syntax highlighting themes are also available in :guilabel:`Preferences`. These are
-separate settings because there are a lot more options for syntax highlighting.
+Switching the GUI colour theme does not affect the colours of the editor and viewer. They have
+separate colour selectable from the "Document colour theme" setting in **Preferences**. They are
+separated because there are a lot more options to choose from for the editor and viewer.
 
 .. note::
-   If you switch to dark mode on the GUI, you should also switch syntax highlighting theme to
+
+   If you switch between light and dark mode on the GUI, you should also switch editor theme to
    match, otherwise icons may be hard to see in the editor and viewer.
 
 
+Project Search
+--------------
+
+A global search tool is available from the side bar. It allows you to search through your entire
+project. The tool does not provide a replace feature. There is a search and replace tool available
+in the document editor that acts on the open document.
+
+.. versionadded:: 2.4
+
+
+Switching Focus
+---------------
+
+If the project or novel view does not have focus, pressing :kbd:`Ctrl+T` switches focus to
+whichever of the two is visible. If one of them already has focus, the key press will switch
+between them instead.
+
+Likewise, pressing :kbd:`Ctrl+E` will switch focus to the document editor or viewer, or if any of
+them already have focus, it will switch focus between them,
+
+These two shortcuts make it possible to jump between all these GUI elements without having to reach
+for the mouse or touchpad.
+
+
 .. _a_breakdown_project:
 
 Project Layout
 ==============
 
-This is a brief introduction to how you structure your writing projects. All of this will be
+This is a brief introduction to how you should structure your writing projects. All of this will be
 covered in more detail later.
 
 The main point of novelWriter is that you are free to organise your project documents as you wish
-into subfolders or subdocuments, and split the text between these documents in whatever way suits
+into sub-folders or sub-documents, and split the text between these documents in whatever way suits
 you. All that matters to novelWriter is the linear order the documents appear at in the project
 tree (top to bottom). The chapters, scenes and sections of the novel are determined by the headings
 within those documents.
 
-The four heading levels (**H1** to **H4**) are treated as follows:
+.. figure:: images/fig_header_levels.png
 
-* **H1** is used for the book title, and for partitions.
-* **H2** is used for chapter tiles.
-* **H3** is used for scene titles – optionally replaced by separators.
-* **H4** is for section titles within scenes, if such granularity is needed.
+   An illustration of how heading levels correspond to the novel structure.
+
+The four heading levels, **Level 1** to **Level 4**, are treated as follows:
+
+* **Level 1** is used for the novel title, and for partitions.
+* **Level 2** is used for chapter tiles.
+* **Level 3** is used for scene titles -- optionally replaced by separators.
+* **Level 4** is for section titles within scenes, if such granularity is needed.
 
 The project tree will select an icon for the document based on the first heading in it.
 
-This header level structure is only taken into account for novel documents. For the project notes,
-the header levels have no structural meaning, and the user is free to do whatever they want. See
-:ref:`a_struct` and :ref:`a_notes` for more details.
+This heading level structure is only taken into account for :term:`novel documents`. For
+:term:`project notes`, the heading levels have no structural meaning, and you are free to use them
+however you want. See :ref:`a_struct` and :ref:`a_references` for more details.
 
-.. note::
-   You can add documents as child items of other documents if you wish. This is often more useful
-   than adding folders, since you anyway may want to have the chapter heading in a separate
-   document from your individual scene documents.
+.. tip::
+
+   You can add documents as child items of other documents. This is often more useful than adding
+   folders, since you anyway may want to have the chapter heading in a separate document from your
+   individual scene documents so that you can rearrange scene documents freely without affecting
+   chapter placement.
+
+.. versionadded:: 2.6
+
+   The heading levels for partitions, chapters and scenes only apply within novelWriter. When you
+   generate your manuscript, chapters are considered as the topmost heading level, with scenes
+   below it. Partitions are inserted as text elements in most formats.
 
 
 .. _a_breakdown_export:
 
-Building the Manuscript
-=======================
+Building a Manuscript
+=====================
 
 The project can at any time be assembled into a range of different formats through the
-:guilabel:`Build Novel Project` tool. Natively, novelWriter supports `Open Document`_, HTML5, and
-various flavours of Markdown.
+**Build Manuscript** tool. Natively, novelWriter supports `Open Document`_, Microsoft Word Document
+(known as `Office Open XML`_), HTML5, and various flavours of Markdown. You can also generate a PDF
+document.
 
 The HTML5 format is suitable for conversion by a number of other tools like Pandoc_, or for
-importing into word processors if the Open Document format isn't suitable. In addition, printing
-and printing to PDF is also possible. 
+importing into word processors if the Open Document or Word Document format isn't suitable. The
+Open Document format is supported by most office type applications, so is the Word Document format.
+In addition, printing is also possible.
 
-You can also export the content of the project to a JSON file. This is useful if you want to write
-your own processing script in for instance Python, as the entire novel can be read into a Python
-dictionary with a couple of lines of code. The JSON file can be populated either with HTML
-formatted text, or with the raw text as typed into the novel documents. See :ref:`a_export_options`
-for more details.
+For advanced processing, you can export the content of the project to a JSON file. This is useful
+if you want to write your own custom processing script in for instance Python, as the entire novel
+can be read into a Python dictionary with a couple of lines of code. The JSON file can be populated
+with either HTML formatted text, or with the raw text as typed it into the novel documents.
 
-A number of filter options can be applied to the :guilabel:`Build Novel Project` tool, allowing you
-to make a draft manuscript, a reference document of notes, an outline based on chapter and scene
-titles with a synopsis each, and so on. See :ref:`a_export` for more details on build features and
-formats.
+See :ref:`a_manuscript` for more details.
+
+.. versionadded:: 2.1
+
+   You can now define multiple build definitions in the **Build Manuscript** tool. This allows you
+   to define specific settings for various types of draft documents, outline documents, and
+   manuscript formats. See :ref:`a_manuscript` for more details.
 
 
 .. _a_breakdown_storage:
@@ -178,16 +254,22 @@ Project Storage
 
 The files of a novelWriter project are stored in a dedicated project folder. The project structure
 is kept in a file at the root of this folder called ``nwProject.nwx``. All the document files and
-associated meta data is stored in the other folders below the project folder. For more technical
-details about what all the files mean and how they're organised, see the :ref:`a_storage` section.
+associated meta data are stored in other folders below the project folder. For a more technical
+description of what all the files mean and how they're organised, see the :ref:`a_storage` section.
 
-This way of storing data was chosen for several reasons. Firstly, all the text you add to your
-project is saved directly to your project folder in separate files. Only the project structure and
-the text you are currently editing is stored in memory at any given time. Secondly, having multiple
-small files means it is very easy to sync them between computers with standard file synchronisation
-tools. Thirdly, if you use version control software to track the changes to your project, the file
-formats used for the files are well suited. Also the JSON documents have line breaks and indents,
-which makes it easier to track them with version control software.
+This way of storing data was chosen for several reasons.
+
+Firstly, all the text you add to your project is saved directly to your project folder in separate
+files. Only the project structure and the text you are currently editing is stored in memory at any
+given time, which means there is a smaller risk of losing data if the application or your computer
+crashes.
+
+Secondly, having multiple small files means it is very easy to synchronise them between computers
+with standard file synchronisation tools.
+
+Thirdly, if you use `version control`_ software to track the changes to your project, the file
+formats used for the files are well suited. All the JSON documents have line breaks and indents as
+well, which makes it easier to track them with version control software.
 
 .. note::
 
@@ -198,12 +280,11 @@ which makes it easier to track them with version control software.
 
 .. caution::
 
-   You should not add additional files to the project folder yourself. Nor should you manually edit
-   files within it as a general rule. If you really must manually edit the text files, e.g. with
-   some automated task you want to perform, you need to rebuild the index when you open the project
-   again.
+   You should not add additional files to the project folder yourself. Nor should you, as a rule,
+   manually edit files within it. If you really must manually edit the text files, e.g. with some
+   automated task you want to perform, you need to rebuild the :term:`Project Index` when you open
+   the project again.
 
-   Editing text files in the ``content`` folder is less risky as they are just plain text. Editing
+   Editing text files in the ``content`` folder is less risky as these are just plain text. Editing
    the main project XML file, however, may make the project file unreadable and you may crash
    novelWriter and lose project structure information and project settings.
-

docs/source/usage_format.rst

@@ -6,12 +6,17 @@ Formatting Your Text
 
 The novelWriter text editor is a plain text editor that uses formatting codes for setting meta data
 values and allowing for some text formatting. The syntax is based on Markdown, but novelWriter is
-*not* a Markdown editor. It supports basic formatting like emphasis (italic), strong importance
-(bold) and strikethrough text, as well as four levels of headings.
+**not** a Markdown editor. It supports basic formatting like emphasis (italic), strong importance
+(bold) and strike through text, as well as four levels of headings. For some further complex
+formatting needs, a set of shortcodes can be used.
 
-In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a set of
-keyword and value sets used for tags and references. There are also some codes that apply two whole
-paragraphs. See :ref:`a_fmt_text` below for more details.
+In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a number of
+keyword and value sets used for :term:`tags<tag>` and :term:`references<reference>`. There are also
+some codes that apply to whole paragraphs. See :ref:`a_fmt_text` for more details.
+
+URLs should also be highlighted and become clickable. However, only URLs starting with "http" or
+"https" are recognised. In the editor, you must hold down the :kbd:`Ctrl` key when clicking a URL
+to follow it.
 
 
 .. _a_fmt_hlight:
@@ -20,16 +25,21 @@ Syntax Highlighting
 ===================
 
 The editor has a syntax highlighter feature that is meant to help you know when you've used the
-formtatting tags or other features correctly. It will change the colour and font size of your
+formatting tags or other features correctly. It will change the colour and font size of your
 headings, change the text colour of emphasised text, and it can also show you where you have
 dialogue in your text.
 
-When you use the commands to set tags and references, these also change colour. Correct commands
-have a dedicated colour, and the references themselves will get a colour if they are valid. Invalid
+.. figure:: images/fig_references.png
+
+   An example of the colour highlighting of references. "Bob" is not defined, and "@blabla" is not
+   a valid reference type.
+
+When you use the keywords to set tags and references, these also change colour. Correct keywords
+have a distinct colour, and the references themselves will get a colour if they are valid. Invalid
 references will get a squiggly error line underneath. The same applies to duplicate tags.
 
 There are a number of syntax highlighter colour themes available, both for light and dark GUIs. You
-can select them for :guilabel:`Preferences`.
+can select them from **Preferences**.
 
 
 .. _a_fmt_head:
@@ -37,41 +47,55 @@ can select them for :guilabel:`Preferences`.
 Headings
 ========
 
-Four levels of headings are allowed. For project notes, they are free to be used as you see fit.
-That is, novelWriter doesn't assign the different headings any particular meaning. However, for
-novel documents they indicate the structural level of the novel and must be used correctly to
-produce the intended result. See :ref:`a_struct_heads` for more details.
+.. figure:: images/fig_header_levels.png
+
+   An illustration of how heading levels correspond to the novel structure.
+
+Four levels of headings are allowed. For :term:`project notes`, they are free to be used as you see
+fit. That is, novelWriter doesn't assign the different headings any particular meaning. However,
+for :term:`novel documents` they indicate the structural level of the novel and must be used
+correctly to produce the intended result. See :ref:`a_struct_heads` for more details.
 
 ``# Title Text``
-   Heading level one. For novel documents, the header level indicates the start of a new partition.
+   Heading level one. For novel documents, the level indicates the start of a new partition.
+   Partitions are for when you want to split your story into "Part 1", "Part 2", etc. You can also
+   choose to use them for splitting the text up into acts, and then hide these headings in your
+   manuscript.
 
 ``## Title Text``
-   Heading level two. For novel documents, the header level indicates the start of a new chapter.
-   Chapter numbers can be inserted automatically when building the manuscript.
+   Heading level two. For novel documents, the level indicates the start of a new chapter. Chapter
+   numbers can be inserted automatically when building the manuscript.
 
 ``### Title Text``
-   Heading level three. For novel documents, the header level indicates the start of a new scene.
-   Scene numbers or scene separators can be inserted automatically when building the manuscript,
-   so you can use the title field as a working title for your scenes if you wish.
+   Heading level three. For novel documents, the level indicates the start of a new scene. Scene
+   numbers or scene separators can be inserted automatically when building the manuscript, so you
+   can use the title field as a working title for your scenes if you wish, but you must provide a
+   minimal title.
 
 ``#### Title Text``
-   Heading level four. For novel documents, the header level indicates the start of a new section.
-   Section titles can be replaced by separators or removed completely when building the manuscript.
+   Heading level four. For novel documents, the level indicates the start of a new section. Section
+   titles can be replaced by separators or ignored completely when building the manuscript.
 
-For headers level one and two, adding a ``!`` modifies the behaviour of the heading:
+For headings level one through three, adding a ``!`` modifies the meaning of the heading:
 
 ``#! Title Text``
-   This tells the build tool that the level one heading is intended to be used for the novel's
-   main title, like for instance on the front page. When building the manuscript, this will use a
-   different styling and will exclude the title from for instance a Table of Contents in Libre
-   Office.
+   This tells the build tool that the level one heading is intended to be used for the novel or
+   notes folder's main title, like for instance the novel title on the cover page. When building
+   the manuscript, this will use a different styling.
 
 ``##! Title Text``
    This tells the build tool to not assign a chapter number to this chapter title if automatic
-   chapter numbers are being used. Such titles are useful for a prologue for instance. See
-   :ref:`a_struct_heads_unnum` for more details.
+   chapter numbers are being used. Such titles are useful for prologues and epilogues for instance.
+   See :ref:`a_struct_heads_unnum` for more details.
+
+``###! Title Text``
+   This is an alternative scene heading that can be formatted differently in the **Manuscript
+   Build** tool. It is intended for separating "soft" and "hard" scene breaks. Aside from this, it
+   behaves identically to a regular scene heading. See :ref:`a_struct_heads_scenes` for more
+   details.
 
 .. note::
+
    The space after the ``#`` or ``!`` character is mandatory. The syntax highlighter will change
    colour and font size when the heading is correctly formatted.
 
@@ -85,42 +109,49 @@ A text paragraph is indicated by a blank line. That is, you need two line breaks
 fragments of text into two paragraphs. Single line breaks are treated as line breaks within a
 paragraph.
 
-In addition, the editor supports a few additional types of whitespaces:
+In addition, the editor supports a few additional types of white spaces:
 
-* A non-breaking space can be inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Space`.
-* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl`:kbd:`K`, 
-  :kbd:`Shift`:kbd:`Space`.
-* Non-breaking thin space can be inserted  with :kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`.
+* A non-breaking space can be inserted with :kbd:`Ctrl+K`, :kbd:`Space`.
+* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl+K`, :kbd:`Shift+Space`.
+* Non-breaking thin space can be inserted with :kbd:`Ctrl+K`, :kbd:`Ctrl+Space`.
 
-These are all insert features, and the :guilabel:`Insert` menu has more. They are also listed
-in :ref:`a_kb_ins`.
+These are all insert features, and the **Insert** menu has more. The keyboard shortcuts for them
+are also listed in :ref:`a_kb_ins`.
 
 Non-breaking spaces are highlighted by the syntax highlighter with an alternate coloured
 background, depending on the selected theme.
 
 .. tip::
+
    Non-breaking spaces are for instance the correct type of space to separate a number from its
    unit. Generally, non-breaking spaces are used to prevent line wrapping algorithms from adding
    line breaks where they shouldn't.
 
+.. note::
+
+   You should not manually apply text indentation in your paragraphs in the editor. These can be
+   added automatically in the **Manuscript Build** tool if you want to have them in the manuscript.
+   Each new paragraph should be separated from the previous content by an empty line and with no
+   indentation.
+
 
 .. _a_fmt_emph:
 
-Text Emphasis
-=============
+Text Emphasis with Markdown
+===========================
 
-A minimal set of text emphasis styles are supported.
+A minimal set of Markdown text emphasis styles are supported for text paragraphs.
 
 ``_text_``
    The text is rendered as emphasised text (italicised).
 
 ``**text**``
-   The text is rendered as strongly important text (bold).
+   The text is rendered as strongly emphasised text (bold).
 
 ``~~text~~``
-   Strikethrough text.
+   Strike through text.
 
-In markdown guides it is often recommended to differentiate between strong importance and emphasis
+In Markdown guides it is often recommended to differentiate between strong emphasis and emphasis
 by using ``**`` for strong and ``_`` for emphasis, although Markdown generally also supports ``__``
 for strong and ``*`` for emphasis. However, since the differentiation makes the highlighting and
 conversion significantly simpler and faster, in novelWriter this is a rule, not just a
@@ -128,15 +159,65 @@ recommendation.
 
 In addition, the following rules apply:
 
-1. The emphasis and strikethrough formatting tags do not allow spaces between the words and the tag
-   itself. That is, ``**text**`` is valid, ``**text **`` is not.
+1. The emphasis and strike through formatting tags do not allow spaces between the words and the
+   tag itself. That is, ``**text**`` is valid, ``**text **`` is not.
 2. More generally, the delimiters must be on the outer edge of words. That is, ``some **text in
    bold** here`` is valid, ``some** text in bold** here`` is not.
-3. If using both ``**`` and ``_`` to wrap the same text, the underscore must be the inner wrapper.
-   This is due to the underscore also being a valid word character, so if they are on the outside,
-   they violate rule 2.
+3. If using both ``**`` and ``_`` to wrap the same text, the underscore must be the **inner**
+   wrapper. This is due to the underscore also being a valid word character, so if they are on the
+   outside, they violate rule 2.
 4. Text emphasis does not span past line breaks. If you need to add emphasis to multiple lines or
    paragraphs, you must apply it to each of them in turn.
+5. Text emphasis can only be used in comments and paragraphs. Headings and meta data tags don't
+   allow for formatting, and any formatting markup will be rendered as-is.
+
+.. tip::
+
+   novelWriter supports standard escape syntax for the emphasis markup characters in case the
+   editor misunderstands your intended usage of them. That is, ``\*``, ``\_`` and ``\~`` will
+   generate a plain ``*``, ``_`` and ``~``, respectively, without interpreting them as part of the
+   markup.
+
+
+.. _a_fmt_shortcodes:
+
+Formatting with Shortcodes
+==========================
+
+For additional formatting options, you can use shortcodes. Shortcodes is a form of in-line codes
+that can be used to change the format of the text that follows and opening code, and last until
+that formatting region is ended with a closing code.
+
+These shortcodes are intended for special formatting cases, or more complex cases that cannot be
+solved with simple Markdown-like formatting codes. Available shortcodes are listed below.
+
+.. csv-table:: Shortcodes Formats
+   :header: "Syntax", "Description"
+   :widths: 40, 60
+   :class: "tight-table"
+
+   "``[b]text[/b]``",     "Text is rendered as bold text."
+   "``[i]text[/i]``",     "Text is rendered as italicised text."
+   "``[s]text[/s]``",     "Text is rendered as strike through text."
+   "``[u]text[/u]``",     "Text is rendered as underlined text."
+   "``[m]text[/m]``",     "Text is rendered as highlighted text."
+   "``[sup]text[/sup]``", "Text is rendered as superscript text."
+   "``[sub]text[/sub]``", "Text is rendered as subscript text."
+
+Unlike Markdown style codes, these can be used anywhere within a paragraph. Even in the middle of a
+word if you need to. You can also freely combine them to form more complex formatting.
+
+The shortcodes are available from the **Format** menu and in the editor toolbar, which can be
+activated by clicking the left-most icon button in the editor header.
+
+.. note::
+
+   Shortcodes are not processed until you generate a preview or generate a manuscript document. So
+   there is no highlighting of the text between the formatting markers. There is also no check that
+   your markers make sense. You must ensure that you have both the opening and closing formatting
+   markers where you want them.
+
+.. versionadded:: 2.2
 
 
 .. _a_fmt_comm:
@@ -144,28 +225,101 @@ In addition, the following rules apply:
 Comments and Synopsis
 =====================
 
-In addition to these standard Markdown features, novelWriter also allows for comments in documents.
-The text of a comment is ignored by the word counter. The text can also be filtered out when
-building the manuscript or viewing the document.
+In addition to the above formatting features, novelWriter also allows for comments in documents.
+The text of a comment is always ignored by the word counter. The text can also be filtered out
+when building the manuscript or viewing the document.
 
-If the first word of a comment is ``Synopsis:`` (with the colon included), the comment is treated
-specially and will show up in the :ref:`a_ui_outline` in a dedicated column. The word ``synopsis``
-is not case sensitive. If it is correctly formatted, the syntax highlighter will indicate this by
-altering the colour of the word.
+The first word of a comment, followed by a colon, can be one of a set of modifiers that indicates
+the comment is intended for a specific purpose. For instance, if the comment starts with
+``Synopsis:``, the comment is treated in a special manner and will show up in the
+:ref:`a_ui_outline` in a dedicated column. The word ``synopsis`` is not case sensitive. If it is
+correctly formatted, the syntax highlighter will indicate this by altering the colour of the word.
 
-``% text...``
-   This is a comment. The text is not renderred by default (this can be overridden), seen in the
-   document viewer, or counted towards word counts.
+The different styles of comments are as follows:
 
-``% Synopsis: text...``
+``% Your comment text ...``
+   This is a comment. The text is not rendered by default (this can be overridden), seen in the
+   document viewer, or counted towards word counts. It is intended for you to make notes in your
+   text for your own sake, whatever that may be, that isn't part of the story text. This is the
+   general format of a comment.
+
+``%Synopsis: Your synopsis text ...``
    This is a synopsis comment. It is generally treated in the same way as a regular comment, except
    that it is also captured by the indexing algorithm and displayed in the :ref:`a_ui_outline`. It
    can also be filtered separately when building the project to for instance generate an outline
    document of the whole project.
 
+``%Short: Your short description ...``
+   This is a short description comment. It is identical to the synopsis comment (they are
+   interchangeable), but is intended to be used for project notes. The text shows up in the
+   Reference panel below the document viewer in the last column labelled **Short Description**.
+
+``%Footnote.<key>: Your footnote text ...``
+   This is a special comment assigned to a footnote marker. See :ref:`a_fmt_footnote` for how to
+   use them in your text.
+
 .. note::
-   Only one comment can be flagged as a synopsis comment for each heading. If multiple comments are
-   flagged as synopsis comments, the last one will be used and the rest ignored.
+
+   Only one comment can be flagged as a synopsis or short comment for each heading. If multiple
+   comments are flagged as synopsis or short comments, the last one will be used and the rest
+   ignored.
+
+
+.. _a_fmt_footnote:
+
+Footnotes
+=========
+
+Footnotes are added with a shortcode, paired with a matching comment for the actual footnote text.
+The matching is done with a key that links the two. If you insert a footnote from the **Insert**
+menu, a unique key is generated for you.
+
+The insert feature will add the footnote shortcode marker at the position of your cursor in the
+text, and create the associated footnote comment right after the paragraph, and move the cursor
+there so you can immediately start typing the footnote text.
+
+The footnote comment can be anywhere in the document, so if you wish to move them to, say, the
+bottom of the text, you are free to do so.
+
+Footnote keys are only required to be unique within a document, so if you copy, move or merge text,
+you must make sure the keys are not duplicated. If you use the automatically generated keys from
+the **Insert** menu, they are unique among all indexed documents. They are not guaranteed to be
+unique against footnotes in the Archive or Trash folder though, but the chance of accidentally
+generating the same key twice in a project is relatively small in the first place (1 in 810 000).
+
+This is what a footnote inserted into a paragraph may look like when completed:
+
+.. code-block:: md
+
+   This is a text paragraph with a footnote[footnote:fn1] in the middle.
+
+   %Footnote.fn1: This is the text of the footnote.
+
+.. versionadded:: 2.5
+
+
+.. _a_fmt_ignore:
+
+Ignored Text
+============
+
+If you want to completely ignore some of the text in your documents, but are not ready to delete
+it, you can add ``%~`` before the text paragraph or line. This will cause novelWriter to skip the
+text entirely when generating previews or building manuscripts.
+
+This is a better way of removing text than converting them to regular comments, as you may want to
+include regular comments in your previews or draft manuscript.
+
+You can toggle the ignored text feature on and off for a paragraph by pressing :kbd:`Ctrl+Shift+D`
+on your keyboard with your cursor somewhere in the paragraph.
+
+Example:
+
+.. code-block:: md
+
+   %~ This text is ignored.
+
+   This text is a regular paragraph.
 
 
 .. _a_fmt_tags:
@@ -174,15 +328,24 @@ Tags and References
 ===================
 
 The document editor supports a set of keywords used for setting tags, and making references between
-documents. The tag can be set once per section defined by a heading. Setting it multiple times
-under the same heading will just override the previous setting. References can be set anywhere
-within a section, and are collected according to their category.
+documents based on those tags.
 
-``@keyword: value``
-   A keyword argument followed by a value, or a comma separated list of values.
+You must use the keyword ``@tag:`` to define a tag. The tag can be set once per section defined by
+a heading. Setting it multiple times under the same heading will just override the previous
+setting.
 
-The available tag and reference keywords are listed in the :ref:`a_struct_tags` section. They can
-also be inserted at the cursor position in the editor via the :guilabel:`Insert` menu.
+``@tag: value``
+   A tag keyword followed by the tag value, like for instance the name of a character.
+
+References can be set anywhere within a section, and are collected according to their category.
+References are on the form:
+
+``@keyword: value1, value2, ..., valueN``
+   A reference keyword followed by a value, or a comma separated list of values.
+
+Tags and references are covered in detail in the :ref:`a_references` chapter. The keywords can be
+inserted at the cursor position in the editor via the **Insert** menu. If you start typing an ``@``
+on a new line, and auto-complete menu will also pop up suggesting keywords.
 
 
 .. _a_fmt_align:
@@ -190,8 +353,8 @@ also be inserted at the cursor position in the editor via the :guilabel:`Insert`
 Paragraph Alignment and Indentation
 ===================================
 
-All documents have the text by default aligned to the left or justified, depending on your
-Preferences.
+All documents have the text by default aligned to the left or justified, depending on your setting
+in **Preferences**.
 
 You can override the default text alignment on individual paragraphs by specifying alignment tags.
 These tags are double angle brackets. Either ``>>`` or ``<<``. You put them either before or after
@@ -213,12 +376,44 @@ Examples:
    "``>> Centred text <<``",           "The text paragraph is centred."
    "``> Left indented text``",         "The text has an increased left margin."
    "``Right indented text <``",        "The text has an increased right margin."
-   "``> Left/right indented text <``", "The text has an both margins increased."
+   "``> Left/right indented text <``", "The text has both margins increased."
 
 .. note::
+
    The text editor will not show the alignment and indentation live. But the viewer will show them
    when you open the document there. It will of course also be reflected in the document generated
-   from the build tool as long as the format supports paragraph alignment.
+   from the manuscript build tool as long as the format supports paragraph alignment.
+
+
+Alignment with Line Breaks
+--------------------------
+
+If you have line breaks in the paragraph, the markers for all the lines are combined and used for
+the entire paragraph. For the following text, all lines will be centred:
+
+.. code-block:: md
+
+   >> I am the very model of a modern Major-General
+   I've information vegetable, animal, and mineral
+   I know the kings of England, and I quote the fights historical
+   From Marathon to Waterloo, in order categorical <<
+
+
+Alignment with First Line Indent
+--------------------------------
+
+If you have first line indent enabled in your Manuscript build settings, you probably want to
+disable it for text in verses. Adding any alignment tags will cause the first line indent to be
+switched off for that paragraph.
+
+The following text will always be aligned against the left margin:
+
+.. code-block:: md
+
+   I am the very model of a modern Major-General <<
+   I've information vegetable, animal, and mineral
+   I know the kings of England, and I quote the fights historical
+   From Marathon to Waterloo, in order categorical
 
 
 .. _a_fmt_break:
@@ -226,23 +421,50 @@ Examples:
 Vertical Space and Page Breaks
 ==============================
 
-Adding more than one line break between paragraphs will *not* increase the space between those
+You can apply page breaks to partition, chapter and scene headings for novel documents from the
+**Manuscript Build** tool. If you need to add a page break or additional vertical spacing in other
+places, there are special codes available for this purpose.
+
+Adding more than one line break between paragraphs will **not** increase the space between those
 paragraphs when building the project. To add additional space between paragraphs, add the text
-``[VSPACE]`` on a line of its own, and the build tool will insert a blank paragraph in its place.
+``[vspace]`` on a line of its own, and the build tool will insert a blank paragraph in its place.
 
 If you need multiple blank paragraphs just add a colon and a number to the above code. For
-instance, writing ``[VSPACE:3]`` will insert three blank paragraphs.
+instance, writing ``[vspace:3]`` will insert three blank paragraphs.
 
-Normally, the build tool will insert a page break before all headers of level one and for all
-headers of level two for novel documents, i.e. chapters, but not for project notes.
-
-If you need to add a page break somewhere else, put the text ``[NEW PAGE]`` on a line by itself
-before the text you wish to start on a new page.
-
-Page breaks are automatically added to partition, chapter and unnumbered chapter headers of novel
-documents. If you want such breaks for scenes and sections, you must add them manually.
+If you need to add a page break somewhere, put the text ``[new page]`` on a line by itself before
+the text you wish to start on a new page.
 
 .. note::
+
    The page break code is applied to the text that follows it. It adds a "page break before" mark
-   to the text when exporting to HTML or Open Document. This means that a ``[NEW PAGE]`` which has
+   to the text when exporting to HTML or Open Document. This means that a ``[new page]`` which has
    no text following it, it will not result in a page break.
+
+**Example:**
+
+.. code-block:: md
+
+   This is a text paragraph.
+
+   [vspace:2]
+
+   This is another text paragraph, but there will be two empty paragraphs
+   between them.
+
+   [new page]
+
+   This text will start on a new page if the build format has pages.
+
+
+.. _a_fmt_stats:
+
+Inserting Word Counts in the Text
+=================================
+
+The cover page of a manuscript normally has the word count stated on it. Any statistics value
+collected by novelWriter can be inserted into any document. You can generate the code for this from
+the **Insert** menu under **Word/Character Count**.
+
+The value inserted is the actual count for your entire manuscript, so it is not populated until you
+run the **Manuscript Build** tool. Until then they will show up as "0" in the viewer panel.

docs/source/usage_interface.rst

@@ -1,271 +0,0 @@
-.. _a_ui:
-
-******************
-The User Interface
-******************
-
-.. _Compose Key: https://en.wikipedia.org/wiki/Compose_key
-
-This sections covers in more detail what all the information on the user interface is for, and how
-you can organise your project, and how you use the editor, viewer and outline panel.
-
-
-.. _a_ui_tree:
-
-The Project Tree
-================
-
-The main window contains a project tree in the left-most panel. It shows the entire structure of
-the project, and has four columns:
-
-**Column 1**
-   The first column shows the icon and label of each folder, document, or note in your project. The
-   label is not the same as the title you set inside the document. However, the document's label
-   will appear in the header above the document text itself so you know where in the project an
-   open document belongs. The icon is selected based on the type of item, and for novel documents,
-   the level of the first header in the document text.
-
-**Column 2**
-   The second column shows the word count of the document, or the sum of words of the child items
-   for folders and documents with subdocuments. If the counts seem incorrect, they can be updated
-   by rebuilding the project index from the :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
-
-**Column 3**
-   The third column indicates whether the document is considered active or inactive in the project.
-   You can use this flag to indicate that a document is still in the project, but should not be
-   considered an active part of it. When you run the :guilabel:`Build Novel Project` tool, you can
-   filter based on this flag. You can change this value from the context menu.
-
-**Column 4**
-   The fourth column shows the user-defined status or importance labels you've assigned to each
-   project item. See :ref:`a_ui_tree_status` for more details. You can change these labels from the
-   context menu.
-
-Right-clicking an item in the project tree will open a context menu under the cursor, displaying
-a selection of actions that can be performed on the selected item.
-
-At the top of the tree, you will find a set of buttons.
-
-* The first button is a quick links button that will show you a dropdown menu of all the root 
-  folders in your project. Selecting one will move to that position in the tree. You can also
-  activate this menu by pressing :kbd:`Ctrl`:kbd:`L`.
-* The next two buttons can be used to move items up and down in the project tree. This is the only 
-  way to move root folders.
-* The next button opens a dropdown menu for adding new items to the tree. This includes root 
-  folders. You can also activate this dropdown menu by pressing :kbd:`Ctrl`:kbd:`N`.
-* The last button is a menu of further actions on the entire project tree.
-
-.. tip::
-   Under the :guilabel:`Transform` submenu in the context menu of an item, you will find several
-   options on how to change a document or folder. This includes changing between document and note,
-   splitting them into multiple documents, or merging child items into a single document.
-
-Below the project tree you will find a small details panel showing the full information of the
-currently selected item. This panel also includes the latest paragraph and character counts in
-addition to the word count.
-
-
-.. _a_ui_tree_novel:
-
-The Novel Tree
---------------
-
-An alternative way to view the project structure is the novel tree. You can switch to this view by
-selecting the :guilabel:`Novel Tree View` button in the sidebar. This view is a simplified version
-of the view in the :guilabel:`Outline`. It is convenient when you want to browse the structure of
-the story itself rather than the document files.
-
-.. note::
-   You cannot reorganise the entries in the novel tree, or add any new documents, as that would
-   imply restructuring the content of the document files. Any editing must be done in the project
-   tree. However, you can add new headings to existing documents, or change references, which will
-   be updated in this view.
-
-
-.. _a_ui_tree_status:
-
-Document Importance and Status
-------------------------------
-
-Each document or folder in your project can have either a "Status" or "Importance" flag set. These
-are flags that you control and define yourself. The app doesn't do anything with them at all. To
-modify the labels, go to their respective tabs in :guilabel:`Project Settings`.
-
-The "Status" flag is intended to tag a Novel document as for instance a draft or as completed, and
-the "Importance" flag is intended to tag character notes, or other notes, as for instance a main,
-major or minor character.
-
-Whether a document uses a "Status" or "Importance" flag depends on which root folder it lives in.
-If it's in the :guilabel:`Novel` folder, it uses the "Status" flag, otherwise it uses an
-"Importance" flag. Some folders, like :guilabel:`Trash` and :guilabel:`Archive` allow both.
-
-
-.. _a_ui_tree_dnd:
-
-Project Tree Drag & Drop
-------------------------
-
-The project tree allows drag & drop to a certain extent to allow you to reorder your documents and
-folders. Moving a document in the project tree will affect the text's position when you assemble
-your manuscript in the build tool.
-
-Drag & drop has only limited support for moving documents. In general, bulk actions are not
-allowed. This is deliberate to avoid accidentally messing up your project. If you make a mistake,
-the last move action can be undone by pressing :kbd:`Ctrl`:kbd:`Shift`:kbd:`Z`.
-
-Documents and their folders can be rearranged freely within their root folders. If you move a Novel
-documents out of a Novel folder, it will be converted to a project note. Notes can be moved freely
-between all root folders, but keep in mind that if you move a note into a :guilabel:`Novel` root
-folder, its "Importance" setting will be switched with a "Status" setting. See
-:ref:`a_ui_tree_status`. The old value will not be overwritten though, and should be restored if
-you move it back at some point.
-
-Root folders in the project tree cannot be dragged & dropped at all. If you want to reorder them,
-you can move them up or down with respect to eachother from the arrow buttons at the top of the
-project tree, or by pressing :kbd:`Ctrl`:kbd:`Shift` and the :kbd:`Up` or :kbd:`Down` key.
-
-
-.. _a_ui_edit:
-
-Editing and Viewing Documents
-=============================
-
-To edit a document, double-click it in the project tree, or press the :kbd:`Return` key while
-having it selected. This will open the document in the document editor. The editor uses a
-Markdown-like syntax for some features, and a novelWriter-specific syntax for others. The syntax
-format is described in the :ref:`a_fmt` section.
-
-The editor has a maximise button (toggles the :guilabel:`Focus Mode`) and a close button in the
-top–right corner. On the top–left side you will find an edit button that opens the
-:guilabel:`Item Label` dialog for the currently open document, and a search button to open the
-search dialog.
-
-Any document in the project tree can also be viewed in parallel in a right hand side document
-viewer. To view a document, press :kbd:`Ctrl`:kbd:`R`, or select :guilabel:`View Document` in the
-menu or context menu. If you have a middle mouse button, middle-clicking on the document will also
-open it in the viewer.
-
-The document viewed does not have to be the same document as currently being edited. However, If
-you *are* viewing the same document, pressing :kbd:`Ctrl`:kbd:`R` again will update the document
-with your latest changes. You can also press the reload button in the top–right corner of the view
-panel, next to the close button, to achieve the same thing.
-
-Both the document editor and viewer will show the label of the document in the header at the top of
-the edit or view panel. Optionally, the full project path to the document can be shown. This can be
-set in :guilabel:`Preferences`.
-
-.. tip::
-   Clicking on the document title bar will select the document in the project tree and reveal its
-   location, making it easier to locate in a large project.
-
-Any tag reference in the editor can be opened in the viewer by moving the cursor to the label and
-pressing :kbd:`Ctrl`:kbd:`Return`. You can also control-click them with your mouse. In the viewer,
-the references become clickable links. Clicking them will replace the content of the viewer with
-the content of the document the reference points to.
-
-The document viewer keeps a history of viewed documents, which you can navigate with the arrow
-buttons in the top–left corner of the viewer. If your mouse has backward and forward navigation
-buttons, these can be used as well. They work just like the backward and forward features in a
-browser.
-
-At the bottom of the view panel there is a :guilabel:`References` panel. (If it is hidden, click
-the icon to reveal it.) This panel will show links to all documents referring back to the one
-you're currently viewing, if any has been defined. The :guilabel:`Sticky` button will freeze the
-content of the panel to the current document, even if you navigate to another document. This is
-convenient if you want to quickly look through all documents in the list in the
-:guilabel:`References` panel without losing the list in the process.
-
-.. note::
-   The :guilabel:`References` panel relies on an up-to-date index of the project. The index is
-   maintained automatically. However, if anything is missing, or seems wrong, the index can always
-   be rebuilt by selecting :guilabel:`Rebuild Index` from the :guilabel:`Tools` menu, or by
-   pressing :kbd:`F9`.
-
-
-.. _a_ui_edit_search:
-
-Search & Replace
-----------------
-
-The document editor has a search and replace tool that can be activated with :kbd:`Ctrl`:kbd:`F`
-for search mode or :kbd:`Ctrl`:kbd:`H` for search and replace mode.
-
-Pressing :kbd:`Return` while in the search box will search for the next occurrence of the word, and
-:kbd:`Shift`:kbd:`Return` for the previous. Pressing :kbd:`Return` in the replace box, will replace
-the highlighted text and move to the next result.
-
-There are a number of settings for the search tool available as toggle switches above the search
-box. They allow you to search for, in order: matched case only, whole word results only, search
-using regular expressions, loop search when reaching the end of the document, and move to the next
-document when reaching the end. There is also a switch that will try to match the case of the word
-when the replacement is made. That is, it will try to keep the word upper, lower, or capitalised to
-match the word being replaced.
-
-The regular expression search is somewhat dependant on which version of Qt your system has. If you
-have Qt 5.13 or higher, there is better support for unicode symbols in the search.
-
-
-.. _a_ui_edit_auto:
-
-Auto-Replace as You Type
-========================
-
-A few auto-replace features are supported by the editor. You can control every aspect of the
-auto-replace feature from :guilabel:`Preferences`. You can also disable this feature entirely if
-you wish.
-
-.. tip::
-   If you don't like auto-replacement, all symbols inserted by this feature are also available in
-   the :guilabel:`Insert` menu, and via convenient :ref:`a_kb_ins`. You may also be using a
-   `Compose Key`_ setup, which means you may not need the auto-replace feature.
-
-The editor is able to replace two and three hyphens with short and long dashes, triple points with
-ellipsis, and replace straight single and double quotes with user-defined quote symbols. It will
-also try to determine whether to use the opening or closing symbol, although this feature isn't
-always accurate. Especially distinguishing between closing single quote and apostrophe can be
-tricky for languages that use the same symbol for these, like English does.
-
-.. tip::
-   If the auto-replace feature changes a symbol when you did not want it to change, pressing
-   :kbd:`Ctrl`:kbd:`Z` immediately after the auto-replacement will undo it without undoing the
-   character you typed.
-
-
-.. _a_ui_outline:
-
-Project Outline View
-====================
-
-The project's Outline view is available as another view option from the views bar. The outline
-provides an overview of the novel structure, displaying a tree hierarchy of the elements of the
-novel, that is, the level 1 to 4 headings representing partitions, chapters, scenes and sections.
-
-The document containing the heading can also be displayed as a separate column, as well as the line
-number where it occurs. Double-clicking an entry will open the corresponding document in the
-editor.
-
-You can select which novel folder to display from the dropdown menu. You can optionally also choose
-to show a combination of all novel folders.
-
-.. note::
-   Since the internal structure of the novel does not depend directly on the folder and document
-   structure of the project tree, these will not necessarily look the same, depending on how you
-   choose to organise your documents. See the :ref:`a_struct` page for more details.
-
-Various meta data and information extracted from tags can be displayed in columns in the outline.
-A default set of such columns is visible, but you can turn on or off more columns from the menu
-button in the toolbar. The order of the columns can also be rearranged by dragging them to a
-different position. You column settings are saved between sessions on a per-project basis.
-
-.. note::
-   The :guilabel:`Title` column cannot be disabled or moved.
-
-The information viewed in the outline is based on the project's main index. While novelWriter does
-its best to keep the index up to date when contents change, you can always rebuild it manually by
-pressing :kbd:`F9` if something isn't right.
-
-The outline view itself can be regenerated by pressing the refresh button. By default, the content
-is refreshed each time you switch to this view.
-
-The :guilabel:`Synopsis` column of the outline view takes its information from a specially
-formatted comment. See :ref:`a_fmt_comm`.

docs/source/usage_project.rst

@@ -0,0 +1,235 @@
+.. _a_ui_project:
+
+*************
+Project Views
+*************
+
+This chapter covers in more detail the different project views available in novelWriter.
+
+.. figure:: images/fig_project_tree_detailed.png
+
+   The **Project Content** tree as it appears when loading a sample project.
+
+
+.. _a_ui_tree:
+
+The Project Tree
+================
+
+The main window contains a project tree in the left-most panel. It shows the entire structure of
+the project, and has four columns.
+
+**Column 1**
+   The first column shows the icon and label of each folder, document, or note in your project. The
+   label is not the same as the heading title you set inside the document. However, the document's
+   label will appear in the header above the document text itself so you know where in the project
+   an open document belongs. The icon is selected based on the type of item, and for novel
+   documents, the level of the first heading in the document text.
+
+**Column 2**
+   The second column shows the word count of the document, or the sum of words of the child items
+   for folders and documents with sub-documents. If the counts seem incorrect, they can be updated
+   by rebuilding the :term:`project index` from the **Tools** menu, or by pressing :kbd:`F9`.
+
+**Column 3**
+   The third column indicates whether the document is considered active or inactive in the project.
+   You can use this flag to indicate that a document is still in the project, but should not be
+   considered an active part of it. When you run the **Build Manuscript** tool, you can include or
+   exclude documents based on this flag. You can change this value from the right-click
+   :term:`context menu`.
+
+**Column 4**
+   The fourth column shows the user-defined status or importance labels you've assigned to each
+   project item. See :ref:`a_ui_tree_status` for more details on how to uses these labels. You can
+   select these labels from the :term:`context menu`, and define them in **Project Settings**.
+
+Right-clicking an item in the project tree will open a context menu under the cursor, displaying
+a selection of actions that can be performed on the selected item.
+
+At the top of the project tree, you will find a set of buttons.
+
+* The first button is a quick links button that will show you a dropdown menu of all the
+  :term:`root folders<root folder>` in your project. Selecting one will move to that position in
+  the tree. You can also activate this menu by pressing :kbd:`Ctrl+L`.
+* The next two buttons can be used to move items up and down in the project tree. This is the only
+  way to move root folders.
+* The next button opens a dropdown menu for adding new items to the tree. This includes root
+  folders and template documents. You can also activate this dropdown menu by pressing
+  :kbd:`Ctrl+N`.
+* The last button is a menu of further actions you can apply to the project tree.
+
+Below the project tree you will find a small details panel showing the full information of the
+currently selected item. This panel also includes the latest paragraph and character counts in
+addition to the word count.
+
+.. tip::
+
+   If you want to set the label of a document to be the same as a header within it, you can
+   right-click a header in the document when it is open in the editor and select
+   :guilabel:`Set as Document Name` from the context menu.
+
+
+.. _a_ui_tree_split_merge:
+
+Splitting and Merging Documents
+-------------------------------
+
+Under the **Transform** submenu in the context menu of an item in the project tree, you will find
+several options on how to change a document or folder. This includes changing between document and
+note, but also splitting them into multiple documents, or merging child items into a single
+document.
+
+
+Splitting Documents
+^^^^^^^^^^^^^^^^^^^
+
+.. figure:: images/fig_project_split_tool.png
+
+   The **Split Document** dialog.
+
+The **Split Document by Headings** option will open a dialog that allows you to split the selected
+document into multiple new documents based on the headings it contains. You can select at which
+heading level the split is to be performed from the dropdown box. The list box will preview which
+headings will be split into new documents.
+
+You are given the option to create a folder for these new documents, and whether or not to create a
+hierarchy of documents. That is, put sections under scenes, and scenes under chapters.
+
+The source document **is not** deleted in the process, but you have the option to let the tool move
+the source document to the :guilabel:`Trash` folder.
+
+
+Merging Documents
+^^^^^^^^^^^^^^^^^
+
+.. figure:: images/fig_project_merge_tool.png
+
+   The **Merge Documents** dialog.
+
+You have two options for merging documents that are child elements of another document. You can
+either **Merge Child Items into Self** and **Merge Child Items into New**. The first option will
+pull all content of child items and merge them into the parent document, while the second option
+will create a new document in the process.
+
+When merging documents in a folder, you only have the latter process is possible, so only the
+choice **Merge Documents in Folder** is available.
+
+In either case, the **Merge Documents** dialog will let you exclude documents you don't want to
+include, and it also lets you reorder them if you wish.
+
+
+.. _a_ui_tree_status:
+
+Document Importance and Status
+------------------------------
+
+Each document or folder in your project can have either a "Status" or "Importance" flag set. These
+are flags that you control and define yourself, and novelWriter doesn't use them for anything. To
+modify the labels, go to their respective tabs in **Project Settings**.
+
+The "Status" flag is intended to tag a :term:`novel document<novel documents>` as for instance a
+draft or as completed, and the "Importance" flag is intended to tag character notes, or other
+:term:`project notes`, as for instance a main, major, or minor character or story element.
+
+Whether a document uses a "Status" or "Importance" flag depends on which :term:`root folder` it
+lives in. If it's in a **Novel** type folder, it uses the "Status" flag, otherwise it uses an
+"Importance" flag.
+
+
+.. _a_ui_tree_dnd:
+
+Project Tree Drag & Drop
+------------------------
+
+The project tree allows drag & drop to allow you to reorder your documents and folders. Moving a
+document in the project tree will affect the text's position when you assemble your manuscript in
+the **Manuscript Build** tool.
+
+.. versionadded:: 2.2
+
+   You can now select multiple items in the project tree by holding down the :kbd:`Ctrl` or
+   :kbd:`Shift` key while selecting items.
+
+Documents and their folders can be rearranged freely within their root folders. If you move a
+**Novel Document** out of a **Novel** folder, it will be converted to a **Project Note**. Notes can
+be moved freely between all root folders, but keep in mind that if you move a note into a **Novel**
+type root folder, its "Importance" setting will be replaced by a "Status" setting. See
+:ref:`a_ui_tree_status`. The old value will not be overwritten though, and should be restored if
+you move it back at some point.
+
+Root folders in the project tree cannot be dragged and dropped at all. If you want to reorder them,
+you can move them up or down with respect to each other from the arrow buttons at the top of the
+project tree, or by pressing :kbd:`Ctrl+Up` or :kbd:`Ctrl+Down` when they are selected.
+
+.. tip::
+
+   You can drag and drop documents onto the editor or viewer panel to open them.
+
+
+.. _a_ui_tree_novel:
+
+The Novel Tree View
+===================
+
+.. figure:: images/fig_novel_tree_view.png
+
+   A screenshot of the Novel Tree View.
+
+An alternative way to view the project structure is the novel view. You can switch to this view by
+selecting the :guilabel:`Novel View` button in the sidebar. This view is a simplified version of
+the view in the **Outline View**. It is convenient when you want to browse the structure of the
+story itself rather than the document files.
+
+.. note::
+
+   You cannot reorganise the entries in the novel view, or add any new documents, as that would
+   imply restructuring the content of the document files themselves. Any such editing must be done
+   in the project tree. However, you can add new headings to existing documents, or change
+   references, which will be updated in this view when the document is saved.
+
+
+.. _a_ui_outline:
+
+The Novel Outline View
+======================
+
+.. figure:: images/fig_outline_view.png
+
+   A screenshot of the Novel Outline View.
+
+The project's **Novel Outline View** is available as another view option from the sidebar. The
+outline provides an overview of the novel structure, displaying a tree hierarchy of the elements of
+the novel, that is, the level 1 to 4 headings representing partitions, chapters, scenes and
+sections.
+
+The document containing the heading can also be displayed as a separate column, as well as the line
+number where the heading is defined. Double-clicking an entry will open the corresponding document
+in the editor and switch to **Project Tree View** mode.
+
+You can select which novel folder to display from the dropdown menu. You can optionally also choose
+to show a combination of all novel folders.
+
+.. note::
+
+   Since the internal structure of the novel does not depend directly on the folder and document
+   structure of the project tree, this view will not necessarily look the same, depending on how
+   you choose to organise your documents. See the :ref:`a_struct` page for more details.
+
+Various meta data and information extracted from :term:`tags<tag>` can be displayed in columns in
+the outline. A default set of such columns is visible, but you can turn on or off more columns from
+the menu button in the toolbar. The order of the columns can also be rearranged by dragging them to
+a different position. You column settings are saved between sessions on a per-project basis.
+
+.. note::
+
+   The **Title** column cannot be disabled or moved.
+
+The information viewed in the outline is based on the :term:`project index`. While novelWriter does
+its best to keep the index up to date when contents change, you can always rebuild it manually by
+pressing :kbd:`F9` if something isn't right.
+
+The outline view itself can be regenerated by pressing the refresh button. By default, the content
+is refreshed each time you switch to this view.
+
+The **Synopsis** column of the outline view takes its information from a specially formatted
+comment. See :ref:`a_fmt_comm`.

docs/source/usage_shortcuts.rst

@@ -4,143 +4,196 @@
 Keyboard Shortcuts
 ******************
 
-Most features in novelWriter are available as keyboard shortcuts. This is a reference list if these
-shortcuts. Most of them are also listed in the application.
+Most features in novelWriter are available as keyboard shortcuts. This is a reference list of those
+shortcuts. Most of them are also listed in the application's user interface.
+
+.. note::
+   On MacOS, replace :kbd:`Ctrl` with :kbd:`Cmd`.
 
 
 .. _a_kb_main:
 
-Main Shortcuts
-==============
+Main Window Shortcuts
+=====================
 
-The main shorcuts are as follows:
-
-.. csv-table:: Keyboard Shortcuts
+.. csv-table::
    :header: "Shortcut", "Description"
-   :widths: 22, 78
-   :class: "tight-table"
 
-   ":kbd:`F1`",                          "Open the online user manual."
-   ":kbd:`F2`",                          "If in the project tree, edit an item's label."
-   ":kbd:`F3`",                          "Find next occurrence of search word in current document."
-   ":kbd:`F5`",                          "Open the :guilabel:`Build Novel Project` dialog."
-   ":kbd:`F6`",                          "Open the :guilabel:`Writing Statistics` dialog."
-   ":kbd:`F7`",                          "Re-run spell checker."
-   ":kbd:`F8`",                          "Toggle :guilabel:`Focus Mode`."
-   ":kbd:`F9`",                          "Re-build the project index."
-   ":kbd:`F11`",                         "Toggle full screen mode."
-   ":kbd:`Return`",                      "If in the project tree, open a document for editing."
-   ":kbd:`Alt`:kbd:`1`",                 "Switch focus to the project tree. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`1`."
-   ":kbd:`Alt`:kbd:`2`",                 "Switch focus to document editor. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`2`."
-   ":kbd:`Alt`:kbd:`3`",                 "Switch focus to document viewer. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`3`."
-   ":kbd:`Alt`:kbd:`4`",                 "Switch focus to outline view. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`4`."
-   ":kbd:`Alt`:kbd:`Left`",              "Move backward in the view history of the document viewer."
-   ":kbd:`Alt`:kbd:`Right`",             "Move forward in the view history of the document viewer."
-   ":kbd:`Ctrl`:kbd:`.`",                "Open the context menu in the project tree or the document editor."
-   ":kbd:`Ctrl`:kbd:`,`",                "Open the :guilabel:`Preferences` dialog."
-   ":kbd:`Ctrl`:kbd:`/`",                "Toggle block format as comment."
-   ":kbd:`Ctrl`:kbd:`0`",                "Remove block formatting for block under cursor."
-   ":kbd:`Ctrl`:kbd:`1`",                "Change block format to header level 1."
-   ":kbd:`Ctrl`:kbd:`2`",                "Change block format to header level 2."
-   ":kbd:`Ctrl`:kbd:`3`",                "Change block format to header level 3."
-   ":kbd:`Ctrl`:kbd:`4`",                "Change block format to header level 4."
-   ":kbd:`Ctrl`:kbd:`5`",                "Change block alignment to left-aligned."
-   ":kbd:`Ctrl`:kbd:`6`",                "Change block alignment to centred."
-   ":kbd:`Ctrl`:kbd:`7`",                "Change block alignment to right-aligned."
-   ":kbd:`Ctrl`:kbd:`8`",                "Add a left margin to the block."
-   ":kbd:`Ctrl`:kbd:`9`",                "Add a right margin to the block."
-   ":kbd:`Ctrl`:kbd:`A`",                "Select all text in the document."
-   ":kbd:`Ctrl`:kbd:`B`",                "Format selected text, or word under cursor, with strong emphasis (bold)."
-   ":kbd:`Ctrl`:kbd:`C`",                "Copy selected text to clipboard."
-   ":kbd:`Ctrl`:kbd:`D`",                "Strikethrough selected text, or word under cursor."
-   ":kbd:`Ctrl`:kbd:`F`",                "Open the search bar and search for the selected word, if any is selected."
-   ":kbd:`Ctrl`:kbd:`G`",                "Find next occurrence of search word in current document."
-   ":kbd:`Ctrl`:kbd:`H`",                "Open the search and replace tool and search for the selected word, if any is selected. (On Mac, this is :kbd:`Cmd`:kbd:`=`.)"
-   ":kbd:`Ctrl`:kbd:`I`",                "Format selected text, or word under cursor, with emphasis (italic)."
-   ":kbd:`Ctrl`:kbd:`K`",                "Activate the insert commands. The commands are listed in :ref:`a_kb_ins`."
-   ":kbd:`Ctrl`:kbd:`L`",                "Open the :guilabel:`Quick Links` menu in the Project Tree."
-   ":kbd:`Ctrl`:kbd:`N`",                "Open the Create New Item menu in the Project Tree."
-   ":kbd:`Ctrl`:kbd:`O`",                "Open selected document."
-   ":kbd:`Ctrl`:kbd:`Q`",                "Exit novelWriter."
-   ":kbd:`Ctrl`:kbd:`R`",                "If in the project tree, open a document for viewing. If in the editor, open current document for viewing."
-   ":kbd:`Ctrl`:kbd:`S`",                "Save the current document in the document editor."
-   ":kbd:`Ctrl`:kbd:`V`",                "Paste text from clipboard to cursor position."
-   ":kbd:`Ctrl`:kbd:`W`",                "Close the current document in the document editor."
-   ":kbd:`Ctrl`:kbd:`X`",                "Cut selected text to clipboard."
-   ":kbd:`Ctrl`:kbd:`Y`",                "Redo latest undo."
-   ":kbd:`Ctrl`:kbd:`Z`",                "Undo latest changes."
-   ":kbd:`Ctrl`:kbd:`F7`",               "Toggle spell checking."
-   ":kbd:`Ctrl`:kbd:`Up`",               "Move item one step up in the project tree."
-   ":kbd:`Ctrl`:kbd:`Down`",             "Move item one step down in the project tree."
-   ":kbd:`Ctrl`:kbd:`Del`",              "Delete next word in editor."
-   ":kbd:`Ctrl`:kbd:`Backspace`",        "Delete previous word in editor."
-   ":kbd:`Ctrl`:kbd:`'`",                "Wrap selected text, or word under cursor, in single quotes."
-   ":kbd:`Ctrl`:kbd:`""`",               "Wrap selected text, or word under cursor, in double quotes."
-   ":kbd:`Ctrl`:kbd:`Return`",           "Open the tag or reference under the cursor in the Viewer."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`,`",    "Open the :guilabel:`Project Settings` dialog."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`/`",    "Remove block formatting for block under cursor."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`1`",    "Replace occurrence of search word in current document, and search for next occurrence."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`A`",    "Select all text in current paragraph."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`G`",    "Find previous occurrence of search word in current document."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`I`",    "Import text to the current document from a text file."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`O`",    "Open a project."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`R`",    "Close the document viewer."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`S`",    "Save the current project."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`W`",    "Close the current project."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`Z`",    "Undo move of project tree item."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`Del`",  "If in the project tree, move an item to Trash."
-   ":kbd:`Shift`:kbd:`F1`",              "Open the local user manual (PDF) if it is available."
-   ":kbd:`Shift`:kbd:`F3`",              "Find previous occurrence of search word in current document."
-   ":kbd:`Shift`:kbd:`F6`",              "Open the :guilabel:`Project Details` dialog."
+   ":kbd:`F1`",           "Open the online user manual"
+   ":kbd:`F5`",           "Open the **Build Manuscript** tool"
+   ":kbd:`F6`",           "Open the **Writing Statistics** tool"
+   ":kbd:`F8`",           "Toggle **Focus Mode**"
+   ":kbd:`F9`",           "Re-build the project's index"
+   ":kbd:`F11`",          "Toggle full screen mode"
+   ":kbd:`Ctrl+,`",       "Open the **Preferences** dialog"
+   ":kbd:`Ctrl+E`",       "Switch or toggle focus for the editor or viewer"
+   ":kbd:`Ctrl+T`",       "Switch or toggle focus for the project tree or novel view"
+   ":kbd:`Ctrl+Q`",       "Exit novelWriter"
+   ":kbd:`Ctrl+Shift+,`", "Open the **Project Settings** dialog"
+   ":kbd:`Ctrl+Shift+O`", "Open the Welcome dialog to open or create a project"
+   ":kbd:`Ctrl+Shift+S`", "Save the current project"
+   ":kbd:`Ctrl+Shift+T`", "Switch focus to the outline view"
+   ":kbd:`Ctrl+Shift+W`", "Close the current project"
+   ":kbd:`Shift+F1`",     "Open the local user manual (PDF) if it is available"
+   ":kbd:`Shift+F6`",     "Open the **Project Details** dialog"
 
-.. note::
-   On macOS, replace :kbd:`Ctrl` with :kbd:`Cmd`.
+
+.. _a_kb_tree:
+
+Project Tree Shortcuts
+======================
+
+.. csv-table::
+   :header: "Shortcut", "Description"
+
+   ":kbd:`F2`",             "Edit the label of the selected item"
+   ":kbd:`Return`",         "Open the selected document in the editor"
+   ":kbd:`Alt+Up`",         "Jump or go to the previous item at same level in the tree"
+   ":kbd:`Alt+Down`",       "Jump or go to the next item at same level in the tree"
+   ":kbd:`Alt+Left`",       "Jump to the parent item in the tree"
+   ":kbd:`Alt+Right`",      "Jump to the first child item in the project tree"
+   ":kbd:`Ctrl+.`",         "Open the context menu on the selected item"
+   ":kbd:`Ctrl+L`",         "Open the **Quick Links** menu"
+   ":kbd:`Ctrl+N`",         "Open the **Create New Item** menu"
+   ":kbd:`Ctrl+O`",         "Open the selected document in the editor"
+   ":kbd:`Ctrl+R`",         "Open the selected document in the viewer"
+   ":kbd:`Ctrl+Up`",        "Move selected item one step up in the tree"
+   ":kbd:`Ctrl+Down`",      "Move selected item one step down in the tree"
+   ":kbd:`Ctrl+Shift+Del`", "Move the selected item to Trash"
+
+
+.. _a_kb_editor:
+
+Document Editor Shortcuts
+=========================
+
+
+Text Search Shortcuts
+---------------------
+
+.. csv-table::
+   :header: "Shortcut", "Description"
+
+   ":kbd:`F3`",           "Find the next occurrence of the search word"
+   ":kbd:`Ctrl+F`",       "Open search and look for the selected word"
+   ":kbd:`Ctrl+G`",       "Find the next occurrence of the search word"
+   ":kbd:`Ctrl+H`",       "Open replace and look for the selected word (Mac :kbd:`Cmd+=`)"
+   ":kbd:`Ctrl+Shift+1`", "Replace selected occurrence, and move to the next"
+   ":kbd:`Ctrl+Shift+G`", "Find the previous occurrence of the search word"
+   ":kbd:`Ctrl+Shift+F`", "Open project search and look for the selected word"
+   ":kbd:`Shift+F3`",     "Find the previous occurrence of the search word"
+
+
+Text Formatting Shortcuts
+-------------------------
+
+.. csv-table::
+   :header: "Shortcut", "Description"
+
+   ":kbd:`Ctrl+'`",       "Wrap selected text, or word under cursor, in single quotes"
+   ":kbd:`Ctrl+""`",      "Wrap selected text, or word under cursor, in double quotes"
+   ":kbd:`Ctrl+/`",       "Toggle comment format for block or selected text"
+   ":kbd:`Ctrl+0`",       "Remove format for block or selected text"
+   ":kbd:`Ctrl+1`",       "Change block format to heading level 1"
+   ":kbd:`Ctrl+2`",       "Change block format to heading level 2"
+   ":kbd:`Ctrl+3`",       "Change block format to heading level 3"
+   ":kbd:`Ctrl+4`",       "Change block format to heading level 4"
+   ":kbd:`Ctrl+5`",       "Change block alignment to left-aligned"
+   ":kbd:`Ctrl+6`",       "Change block alignment to centred"
+   ":kbd:`Ctrl+7`",       "Change block alignment to right-aligned"
+   ":kbd:`Ctrl+8`",       "Add a left margin to the block"
+   ":kbd:`Ctrl+9`",       "Add a right margin to the block"
+   ":kbd:`Ctrl+B`",       "Format selected text, or word under cursor, with bold"
+   ":kbd:`Ctrl+D`",       "Format selected text, or word under cursor, with strike through"
+   ":kbd:`Ctrl+I`",       "Format selected text, or word under cursor, with italic"
+   ":kbd:`Ctrl+Shift+/`", "Remove format for block or selected text"
+   ":kbd:`Ctrl+Shift+D`", "Toggle ignored text format for block or selected text"
+
+
+Other Editor Shortcuts
+----------------------
+
+.. csv-table::
+   :header: "Shortcut", "Description"
+
+   ":kbd:`F7`",             "Re-run the spell checker on the document"
+   ":kbd:`Ctrl+.`",         "Open the context menu at the current cursor location"
+   ":kbd:`Ctrl+A`",         "Select all text in the document"
+   ":kbd:`Ctrl+C`",         "Copy selected text to clipboard"
+   ":kbd:`Ctrl+K`",         "Activate the insert commands (see list in :ref:`a_kb_ins`)"
+   ":kbd:`Ctrl+R`",         "Open or reload the current document in the viewer"
+   ":kbd:`Ctrl+S`",         "Save the current document"
+   ":kbd:`Ctrl+V`",         "Paste text from clipboard to cursor position"
+   ":kbd:`Ctrl+W`",         "Close the current document"
+   ":kbd:`Ctrl+X`",         "Cut selected text to clipboard"
+   ":kbd:`Ctrl+Y`",         "Redo latest undo"
+   ":kbd:`Ctrl+Z`",         "Undo latest changes"
+   ":kbd:`Ctrl+Backspace`", "Delete the word before the cursor"
+   ":kbd:`Ctrl+Del`",       "Delete the word after the cursor"
+   ":kbd:`Ctrl+F7`",        "Toggle spell checking"
+   ":kbd:`Ctrl+Return`",    "Open the tag or reference under the cursor in the viewer"
+   ":kbd:`Ctrl+Shift+A`",   "Select all text in the current paragraph"
 
 
 .. _a_kb_ins:
 
 Insert Shortcuts
-================
+----------------
 
 A set of insert features are also available through shortcuts, but they require a double
-combination of key sequences. The insert feature is activated with :kbd:`Ctrl`:kbd:`K`, followed by
+combination of key sequences. The insert feature is activated with :kbd:`Ctrl+K`, followed by
 a key or key combination for the inserted content.
 
-.. csv-table:: Keyboard Shortcuts
+.. csv-table::
    :header: "Shortcut", "Description"
-   :widths: 30, 70
-   :class: "tight-table"
 
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`−`",                 "Insert a short dash (en dash)."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`_`",                 "Insert a long dash (em dash)."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`_`",      "Insert a horizontal bar (quotation dash)."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`~`",                 "Insert a figure dash (same width as a number)."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`1`",                 "Insert a left single quote."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`2`",                 "Insert a right single quote."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`3`",                 "Insert a left double quote."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`4`",                 "Insert a right double quote."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`'`",                 "Insert a modifier apostrophe."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`.`",                 "Insert an ellipsis."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`'`",      "Insert a prime."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`""`",     "Insert a double prime."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Space`",             "Insert a non-breaking space."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Shift`:kbd:`Space`", "Insert a thin space."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`",  "Insert a thin non-breaking space."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`*`",                 "Insert a list bullet."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`−`",      "Insert a hyphen bullet (alternative bullet)."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`*`",      "Insert a flower mark (alternative bullet)."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`%`",                 "Insert a per mille symbol."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`O`",      "Insert a degree symbol."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`X`",      "Insert a times sign."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`D`",      "Insert a division sign."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`G`",                 "Insert a ``@tag`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`V`",                 "Insert a ``@pov`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`F`",                 "Insert a ``@focus`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`C`",                 "Insert a ``@char`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`P`",                 "Insert a ``@plot`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`S`",                 "Insert a synopsis comment."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`T`",                 "Insert a ``@time`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`L`",                 "Insert a ``@location`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`O`",                 "Insert an ``@object`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`E`",                 "Insert an ``@entity`` keyword."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`X`",                 "Insert a ``@custom`` keyword."
+   ":kbd:`Ctrl+K`, :kbd:`Space`",       "Insert a non-breaking space"
+   ":kbd:`Ctrl+K`, :kbd:`_`",           "Insert a long dash (em dash)"
+   ":kbd:`Ctrl+K`, :kbd:`.`",           "Insert an ellipsis"
+   ":kbd:`Ctrl+K`, :kbd:`'`",           "Insert a modifier apostrophe"
+   ":kbd:`Ctrl+K`, :kbd:`*`",           "Insert a list bullet"
+   ":kbd:`Ctrl+K`, :kbd:`%`",           "Insert a per mille symbol"
+   ":kbd:`Ctrl+K`, :kbd:`~`",           "Insert a figure dash (same width as a number)"
+   ":kbd:`Ctrl+K`, :kbd:`−`",           "Insert a short dash (en dash)"
+   ":kbd:`Ctrl+K`, :kbd:`1`",           "Insert a left single quote"
+   ":kbd:`Ctrl+K`, :kbd:`2`",           "Insert a right single quote"
+   ":kbd:`Ctrl+K`, :kbd:`3`",           "Insert a left double quote"
+   ":kbd:`Ctrl+K`, :kbd:`4`",           "Insert a right double quote"
+   ":kbd:`Ctrl+K`, :kbd:`C`",           "Insert a ``@char`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`E`",           "Insert an ``@entity`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`F`",           "Insert a ``@focus`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`G`",           "Insert a ``@tag`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`H`",           "Insert a short description comment"
+   ":kbd:`Ctrl+K`, :kbd:`L`",           "Insert a ``@location`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`M`",           "Insert a ``@mention`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`O`",           "Insert an ``@object`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`P`",           "Insert a ``@plot`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`S`",           "Insert a synopsis comment"
+   ":kbd:`Ctrl+K`, :kbd:`T`",           "Insert a ``@time`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`V`",           "Insert a ``@pov`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`X`",           "Insert a ``@custom`` keyword"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+Space`",  "Insert a thin non-breaking space"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+_`",      "Insert a horizontal bar (quotation dash)"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+'`",      "Insert a prime"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+""`",     "Insert a double prime"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+*`",      "Insert a flower mark (alternative bullet)"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+−`",      "Insert a hyphen bullet (alternative bullet)"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+D`",      "Insert a division sign"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+O`",      "Insert a degree symbol"
+   ":kbd:`Ctrl+K`, :kbd:`Ctrl+X`",      "Insert a times sign"
+   ":kbd:`Ctrl+K`, :kbd:`Shift+Space`", "Insert a thin space"
+
+
+.. _a_kb_viewer:
+
+Document Viewer Shortcuts
+=========================
+
+.. csv-table::
+   :header: "Shortcut", "Description"
+
+   ":kbd:`Alt+Left`",     "Move backward in the view history"
+   ":kbd:`Alt+Right`",    "Move forward in the view history"
+   ":kbd:`Ctrl+C`",       "Copy selected text to clipboard"
+   ":kbd:`Ctrl+Shift+A`", "Select all text in the current paragraph"
+   ":kbd:`Ctrl+Shift+R`", "Close the document viewer"

docs/source/usage_typography.rst

@@ -11,7 +11,7 @@ Typographical Notes
 
 novelWriter has some support for typographical symbols that are not usually easily available in
 many text editors. This includes for instance the proper unicode quotation marks, dashes, ellipsis,
-thin spaces, etc. All these symbols are available from the :guilabel:`Insert` menu, and via
+thin spaces, etc. All these symbols are available from the **Insert** menu, and via
 keyboard shortcuts. See :ref:`a_kb_ins`.
 
 This chapter provides some additional information on how novelWriter handles these symbols.
@@ -30,8 +30,8 @@ Dashes and Ellipsis
 
 With the auto-replace feature enabled (see :ref:`a_ui_edit_auto`), multiple hyphens are converted
 automatically to short and long dashes, and three dots to ellipsis. The last auto-replace can
-always be reverted with the undo command :kbd:`Ctrl`:kbd:`Z`, reverting the text to what you typed
-before the automatic replacement occurred.
+always be reverted with the undo command :kbd:`Ctrl+Z`, reverting the text to what you typed before
+the automatic replacement occurred.
 
 In addition, "Figure Dash" is available. The Figure Dash is a dash that has the same width as the
 numbers of the same font, for most fonts. It helps to align numbers nicely in columns when you need
@@ -43,25 +43,25 @@ Single and Double Quotes
 
 All the different quotation marks listed on the `Quotation Mark`_ Wikipedia page are available, and
 can be selected as auto-replaced symbols for straight single and double quote key strokes. The
-settings can be found in :guilabel:`Preferences`.
+settings can be found in **Preferences**.
 
 Ordinarily, text wrapped in quotes are highlighted by the editor. This is meant as a convenience
 for highlighting dialogue between characters. This feature can be disabled in
-:guilabel:`Preferences` if this feature isn't wanted.
+**Preferences** if this feature isn't wanted.
 
 The editor distinguishes between text wrapped in regular straight double quotes and the
 user-selected double quote symbols. This is to help the writer recognise which parts of the text
-are not using the chosen quote symbols. Two convenience functions in the :guilabel:`Format` menu
+are not using the chosen quote symbols. Two convenience functions in the **Format** menu
 can be used to re-format a selected section of text with the correct quote symbols.
 
 
 Single and Double Prime
 ------------------------
 
-Both single and double prime symbols are available in the :guilabel:`Insert` menu. These symbols
-are the correct symbols to use for unit symbols for feet, inches, minutes and seconds. The usage of
-these is described in more detail on the Wikipedia Prime_ page. They look very similar to single
-and double straight quotes, and may be renderred similarly by the font, but they have different
+Both single and double prime symbols are available in the **Insert** menu. These symbols
+are the correct symbols to use for unit symbols for feet, inches, minutes, and seconds. The usage
+of these is described in more detail on the Wikipedia Prime_ page. They look very similar to single
+and double straight quotes, and may be rendered similarly by the font, but they have different
 codes. Using these correctly will also prevent the auto-replace and dialogue highlighting features
 misunderstanding their meaning in the text.
 
@@ -74,14 +74,14 @@ even if it is intended as an apostrophe. This also includes the syntax highlight
 assume the first following apostrophe is the closing symbol of a single quoted region of text.
 
 To get around this, an alternative apostrophe is available. It is a special Unicode character that
-is not categorised as punctuation, but as a modifier. It is usually renderred the same way as the
+is not categorised as punctuation, but as a modifier. It is usually rendered the same way as the
 right single quotation marks, depending on the font. There is a Wikipedia article for the
 `Modifier letter apostrophe`_ with more details.
 
 .. note::
-   On export with the :guilabel:`Build Novel Project` tool, these apostrophes will be replaced
+   On export with the **Build Manuscript** tool, these apostrophes will be replaced
    automatically with the corresponding right hand single quote symbol as is generally recommended.
-   Therefore it doesn't really matter if you only use them to correct highlighting.
+   Therefore it doesn't really matter if you only use them to correct syntax highlighting.
 
 
 Special Space Symbols

docs/source/usage_writing.rst

@@ -0,0 +1,188 @@
+.. _a_ui_writing:
+
+*********************
+The Editor and Viewer
+*********************
+
+.. _Compose Key: https://en.wikipedia.org/wiki/Compose_key
+
+This chapter covers in more detail how the document editor and viewer panels work.
+
+
+.. _a_ui_edit:
+
+Editing a Document
+==================
+
+.. figure:: images/fig_editor.png
+
+   A screenshot of the Document Editor panel.
+
+To edit a document, double-click it in the project tree, press the :kbd:`Return` key while having
+it selected, or drag and drop it onto the editor panel. This will open the document in the document
+editor. The editor uses a Markdown-like syntax for some features, and a novelWriter-specific syntax
+for others. The syntax format is described in the :ref:`a_fmt` chapter.
+
+The editor has a maximise button, which toggles the **Focus Mode**, and a close button in the
+top--right corner. On the top--left side you will find a tools button that opens a toolbar with a
+few buttons for applying text formatting, a drop down menu for navigating between headings, and a
+search button to open the search dialog.
+
+Both the document editor and viewer will show the label of the currently open document in the
+header at the top of the edit or view panel. Optionally, the full project path to the document can
+be shown. This can be set in **Preferences**.
+
+.. tip::
+
+   Clicking on the document title bar will select the document in the project tree and thus reveal
+   its location there, making it easier to find in a large project.
+
+Any :term:`references<reference>` in the editor can be opened in the viewer by moving the cursor to
+the label and pressing :kbd:`Ctrl+Return`. You can also control-click them with your mouse.
+
+
+Spell Checking
+--------------
+
+A third party library called Enchant is used for spell checking in the editor. The controls for
+spell checking can be found in the **Tools** menu. You can also set spell checking language in
+**Project Settings**.
+
+This spell checking library comes with support for custom words that you can add by selecting
+"Add Word to Dictionary" from the context menu when a word is highlighted by the spell checker as
+misspelled. The custom words are managed on a per-project basis, and can the list of words can be
+edited from the **Project Word List** tool available from the **Tools** menu.
+
+.. note::
+
+   Generally, spell checking dictionaries are collected from your operating system, but on Windows
+   they are not. See :ref:`a_custom_dict` for how to add spell checking dictionaries on Windows.
+
+
+Editor Auto-Completer
+---------------------
+
+If you type the character ``@`` on a new line, a pop-up menu will appear showing the different
+available keywords. The list will shorten as you type. Once a keyword command has been selected or
+typed, the editor may suggest further options based on your project content. See
+:ref:`a_references_completer` for more details.
+
+.. versionadded:: 2.2
+
+
+.. _a_ui_view:
+
+Viewing a Document
+==================
+
+.. figure:: images/fig_viewer.png
+
+   A screenshot of the Document Viewer panel.
+
+Any document in the project tree can also be viewed in parallel in a right hand side document
+viewer. To view a document, press :kbd:`Ctrl+R`, select **View Document** in the menu or context
+menu, or drag and drop the document onto the viewer panel. If you have a middle mouse button,
+middle-clicking on the document will also open it in the viewer.
+
+The document viewed does not have to be the same document as the one currently being edited.
+However, If you *are* viewing the same document, pressing :kbd:`Ctrl+R` from the editor will update
+the document with your latest changes. You can also press the reload button in the top--right
+corner of the viewer panel, next to the close button, to achieve the same thing.
+
+In the viewer :term:`references<reference>` become clickable links. Clicking them will replace the
+content of the viewer with the content of the document the reference points to.
+
+The document viewer keeps a history of viewed documents, which you can navigate with the arrow
+buttons in the top--left corner of the viewer. If your mouse has backward and forward navigation
+buttons, these can be used as well. They work just like the backward and forward features in a
+browser. The left-most button is a dropdown menu for quickly navigation between headings in the
+document. The edit button on the right will open the viewed document in the editor.
+
+At the bottom of the view panel there is a **References** panel. (If it is hidden, click the button
+on the left side of the footer area to reveal it.) This panel contains a References tab with links
+to all documents referring back to the one you're currently viewing, if any has been defined. If
+you have created root folders and tags for various story elements like characters and plot points,
+these will appear as additional tabs in this panel.
+
+.. note::
+
+   The **References** panel relies on an up-to-date :term:`index<project index>` of the project.
+   The index is maintained automatically. However, if anything is missing, or seems wrong, the
+   index can always be rebuilt by selecting **Rebuild Index** from the **Tools** menu, or by
+   pressing :kbd:`F9`.
+
+.. versionadded:: 2.2
+
+   The reference panel was redesigned and the additional tabs added.
+
+
+.. _a_ui_edit_search:
+
+Search & Replace
+================
+
+.. figure:: images/fig_editor_search.png
+
+   A screenshot of the Document Editor search box.
+
+The document editor has a search and replace tool that can be activated with :kbd:`Ctrl+F` for
+search mode or :kbd:`Ctrl+H` for search and replace mode.
+
+Pressing :kbd:`Return` while in the search box will search for the next occurrence of the word, and
+:kbd:`Shift+Return` for the previous. Pressing :kbd:`Return` in the replace box, will replace the
+highlighted text and move to the next result.
+
+There are a number of settings for the search tool available as toggle switches above the search
+box. They allow you to search for, in order: matched case only, whole word results only, search
+using regular expressions, loop search when reaching the end of the document, and move to the next
+document when reaching the end. There is also a switch that will try to match the case of the word
+when the replacement is made. That is, it will try to keep the word upper, lower, or capitalised to
+match the word being replaced.
+
+.. seealso::
+
+   For more information on the capabilities of the Regular Expression option, see the Qt
+   documentation for the `QRegularExpression <https://doc.qt.io/qt-5/qregularexpression.html>`_
+   class.
+
+
+.. _a_ui_edit_auto:
+
+Auto-Replace as You Type
+========================
+
+A few auto-replace features are supported by the editor. You can control every aspect of the
+auto-replace feature from **Preferences**. You can also disable this feature entirely if you wish.
+
+.. tip::
+
+   If you don't like auto-replacement, all symbols inserted by this feature are also available in
+   the :guilabel:`Insert` menu, and via :ref:`a_kb_ins`. You may also be using a `Compose Key`_
+   setup, which means you may not need the auto-replace feature at all.
+
+The editor is able to replace two and three hyphens with short and long dashes, triple points with
+ellipsis, and replace straight single and double quotes with user-defined quote symbols. It will
+also try to determine whether to use the opening or closing symbol, although this feature isn't
+always accurate. Especially distinguishing between closing single quote and apostrophe can be
+tricky for languages that use the same symbol for these, like English does.
+
+.. tip::
+
+   If the auto-replace feature changes a symbol when you did not want it to change, pressing
+   :kbd:`Ctrl+Z` once after the auto-replacement will undo it without undoing the character
+   you typed before it.
+
+
+.. _a_ui_edit_dialogue:
+
+Dialogue Highlighting
+=====================
+
+The editor and viewer can optionally highlight character dialogue in your novel documents. By
+default, this feature is set to display text in double quotes as dialogue. In **Preferences**, you
+can change this to support various other dialogue markers that instead uses dashes to indicate
+dialogue, like those used in Spanish, Portuguese, Polish, etc.
+
+Various styles are supported by changing the settings under "Text Highlighting" in **Preferences**.
+
+It is also possible to include the dialogue highlighting in your manuscripts.

i18n/README.md

@@ -48,6 +48,7 @@ instance `en_GB` for British English.
 You will need the translation tool Qt 5 Linguist on your system.
 
 For Ubuntu/Debian, run:
+
 ```bash
 sudo apt install qttools5-dev-tools
 ```
@@ -75,8 +76,9 @@ The `i18n` folder at the root of the repository contains the `nw_XX.ts` translat
 
 Whether to add a new language to the translation framework, or to  update the file against the
 current source code, you must first run the `qtlupdate` command:
+
 ```bash
-python3 setup.py qtlupdate i18n/nw_XX.ts
+python3 pkgutils.py qtlupdate i18n/nw_XX.ts
 ```
 
 The file name must be in the correct format. All translation files must be located in the `i18n`
@@ -86,6 +88,10 @@ be a valid ISO language code, otherwise novelWriter will not accept the file.
 For instance, the French translation uses the language code `fr_FR`, so its translation file will
 be `nw_fr_FR.ts`
 
+Note: The `qtlupdate` command needs the `lupdate` tool provided by PyQt6, which uses the latest
+TS file format. The tool in PyQt5 generates an older file format. On Debian/Ubuntu it is provided
+by the package `pyqt6-dev-tools`.
+
 
 ### Edit the Translation File in Qt Linguist
 
@@ -100,8 +106,9 @@ Please select "English" and "United Kingdom" as the _source_ language if prompte
 The application does not use `.ts` files directly. The `novelwriter/assets/i18n/nw_XX.qm` files are
 the actual files used to translate the GUI into another language other than the default British
 English. These files are not generated by default, but they can be built with:
+
 ```bash
-python3 setup.py qtlrelease
+python3 pkgutils.py qtlrelease
 ```
 
 You can now test the translation in novelWriter. The Preferences dialog should list the newly added

i18n/pylupdate6/README.md

@@ -1,7 +0,0 @@
-# PyQt6 Linguist Tool
-
-This is a copy of the `pylupdate` tool from PyQt6 version 6.2.1 from
-[PyPi](https://pypi.org/project/PyQt6/).
-The tool is stripped down to run for novelWriter.
-
-PyQt6 is licensed under GPL 3.0

i18n/pylupdate6/__init__.py

@@ -1,22 +0,0 @@
-# Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
-#
-# This file is part of PyQt6.
-#
-# This file may be used under the terms of the GNU General Public License
-# version 3.0 as published by the Free Software Foundation and appearing in
-# the file LICENSE included in the packaging of this file.  Please review the
-# following information to ensure the GNU General Public License version 3.0
-# requirements will be met: http://www.gnu.org/copyleft/gpl.html.
-#
-# If you do not wish to use this file under the terms of the GPL version 3.0
-# then you may purchase a commercial license.  For more information contact
-# info@riverbankcomputing.com.
-#
-# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
-# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-
-# The public API.
-from .lupdate import lupdate
-
-__all__ = ["lupdate"]

i18n/pylupdate6/lupdate.py

@@ -1,90 +0,0 @@
-# Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
-#
-# This file is part of PyQt6.
-#
-# This file may be used under the terms of the GNU General Public License
-# version 3.0 as published by the Free Software Foundation and appearing in
-# the file LICENSE included in the packaging of this file.  Please review the
-# following information to ensure the GNU General Public License version 3.0
-# requirements will be met: http://www.gnu.org/copyleft/gpl.html.
-#
-# If you do not wish to use this file under the terms of the GPL version 3.0
-# then you may purchase a commercial license.  For more information contact
-# info@riverbankcomputing.com.
-#
-# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
-# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-
-import fnmatch
-import os
-
-# from .designer_source import DesignerSource
-from .python_source import PythonSource
-from .translation_file import TranslationFile
-from .user import UserException
-
-
-def lupdate(
-    sources, translation_files, no_obsolete=False, no_summary=True, verbose=False, excludes=None
-):
-    """ Update a sequence of translation (.ts) files from a sequence of Python
-    source (.py) files, Designer source (.ui) files or directories containing
-    source files.
-    """
-
-    if excludes is None:
-        excludes = ()
-
-    # Read the .ts files.
-    translations = [
-        TranslationFile(ts, no_obsolete=no_obsolete, no_summary=no_summary, verbose=verbose)
-        for ts in translation_files
-    ]
-
-    # Read the sources.
-    source_files = []
-    for source in sources:
-        if os.path.isdir(source):
-            for dirpath, _, filenames in os.walk(source):
-                for fn in filenames:
-                    # Apply any exclusion patterns.
-                    for exclude in excludes:
-                        if fnmatch.fnmatch(fn, exclude):
-                            fn = None
-                            break
-
-                    if fn is None:
-                        continue
-
-                    filename = os.path.join(dirpath, fn)
-
-                    if filename.endswith('.py'):
-                        source_files.append(PythonSource(filename=filename, verbose=verbose))
-
-                    # UI file support is disabled
-                    # elif filename.endswith('.ui'):
-                    #     source_files.append(
-                    #             DesignerSource(filename=filename,
-                    #                     verbose=verbose))
-
-                    elif verbose:
-                        print("Ignoring", filename)
-
-        elif source.endswith('.py'):
-            source_files.append(PythonSource(filename=source, verbose=verbose))
-
-        # UI file support is disabled
-        # elif source.endswith('.ui'):
-        #     source_files.append(
-        #             DesignerSource(filename=source, verbose=verbose))
-
-        else:
-            raise UserException("{0} must be a directory or a .py or a .ui file".format(source))
-
-    # Update each translation for each source.
-    for t in translations:
-        for s in source_files:
-            t.update(s)
-
-        t.write()

i18n/pylupdate6/python_source.py

@@ -1,362 +0,0 @@
-# Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
-#
-# This file is part of PyQt6.
-#
-# This file may be used under the terms of the GNU General Public License
-# version 3.0 as published by the Free Software Foundation and appearing in
-# the file LICENSE included in the packaging of this file.  Please review the
-# following information to ensure the GNU General Public License version 3.0
-# requirements will be met: http://www.gnu.org/copyleft/gpl.html.
-#
-# If you do not wish to use this file under the terms of the GPL version 3.0
-# then you may purchase a commercial license.  For more information contact
-# info@riverbankcomputing.com.
-#
-# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
-# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-
-import ast
-import re
-import tokenize
-
-from .source_file import SourceFile
-from .translations import Context, EmbeddedComments, Message
-from .user import User, UserException
-
-
-class PythonSource(SourceFile, User):
-    """ Encapsulate a Python source file. """
-
-    # The regular expression to extract a PEP 263 encoding.
-    _PEP_263 = re.compile(rb'^[ \t\f]*#.*?coding[:=][ \t]*([-_.a-zA-Z0-9]+)')
-
-    def __init__(self, **kwargs):
-        """ Initialise the object. """
-
-        super().__init__(**kwargs)
-
-        # Read the source file.
-        self.progress("Reading {0}...".format(self.filename))
-        with open(self.filename, 'rb') as f:
-            source = f.read()
-
-        # Implement universal newlines.
-        source = source.replace(b'\r\n', b'\n').replace(b'\r', b'\n')
-
-        # Try and extract a PEP 263 encoding.
-        encoding = 'UTF-8'
-
-        for line_nr, line in enumerate(source.split(b'\n')):
-            if line_nr > 1:
-                break
-
-            match = re.match(self._PEP_263, line)
-            if match:
-                encoding = match.group(1).decode('ascii')
-                break
-
-        # Decode the source according to the encoding.
-        try:
-            source = source.decode(encoding)
-        except LookupError:
-            raise UserException("Unsupported encoding '{0}'".format(encoding))
-
-        # Parse the source file.
-        self.progress("Parsing {0}...".format(self.filename))
-
-        try:
-            tree = ast.parse(source, filename=self.filename)
-        except SyntaxError as e:
-            raise UserException(
-                "Invalid syntax at line {0} of {1}:\n{2}".format(
-                    e.lineno, e.filename, e.text.rstrip()
-                )
-            )
-
-        # Look for translation contexts and their contents.
-        visitor = Visitor(self)
-        visitor.visit(tree)
-
-        # Read the file again as a sequence of tokens so that we see the
-        # comments.
-        with open(self.filename, 'rb') as f:
-            current = None
-
-            for token in tokenize.tokenize(f.readline):
-                if token.type == tokenize.COMMENT:
-                    # See if it is an embedded comment.
-                    parts = token.string.split(' ', maxsplit=1)
-                    if len(parts) == 2:
-                        if parts[0] == '#:':
-                            if current is None:
-                                current = EmbeddedComments()
-
-                            current.extra_comments.append(parts[1])
-                        elif parts[0] == '#=':
-                            if current is None:
-                                current = EmbeddedComments()
-
-                            current.message_id = parts[1]
-                        elif parts[0] == '#~':
-                            parts = parts[1].split(' ', maxsplit=1)
-                            if len(parts) == 1:
-                                parts.append('')
-
-                            if current is None:
-                                current = EmbeddedComments()
-
-                            current.extras.append(parts)
-
-                elif token.type == tokenize.NL:
-                    continue
-
-                elif current is not None:
-                    # Associate the embedded comment with the line containing
-                    # this token.
-                    line_nr = token.start[0]
-
-                    # See if there is a message on that line.
-                    for context in self.contexts:
-                        for message in context.messages:
-                            if message.line_nr == line_nr:
-                                break
-                        else:
-                            message = None
-
-                        if message is not None:
-                            message.embedded_comments = current
-                            break
-
-                    current = None
-
-
-class Visitor(ast.NodeVisitor):
-    """ A visitor that extracts translation contexts. """
-
-    def __init__(self, source):
-        """ Initialise the visitor. """
-
-        self._source = source
-        self._context_stack = []
-
-        super().__init__()
-
-    def visit_Call(self, node):
-        """ Visit a call. """
-
-        # Parse the arguments if a translation function is being called.
-        call_args = None
-
-        if isinstance(node.func, ast.Attribute):
-            name = node.func.attr
-
-            if name == 'tr':
-                call_args = self._parse_tr(node)
-            elif name == 'translate':
-                call_args = self._parse_translate(node)
-
-        elif isinstance(node.func, ast.Name):
-            name = node.func.id
-
-            if name == 'QT_TR_NOOP':
-                call_args = self._parse_QT_TR_NOOP(node)
-            elif name == 'QT_TRANSLATE_NOOP':
-                call_args = self._parse_QT_TRANSLATE_NOOP(node)
-
-        # Update the context if the arguments are usable.
-        if call_args is not None and call_args.source != '':
-            call_args.context.messages.append(
-                Message(
-                    self._source.filename, node.lineno,
-                    call_args.source, call_args.disambiguation,
-                    (call_args.numerus)
-                )
-            )
-
-        self.generic_visit(node)
-
-    def visit_ClassDef(self, node):
-        """ Visit a class. """
-
-        try:
-            name = self._context_stack[-1].name + '.' + node.name
-        except IndexError:
-            name = node.name
-
-        self._context_stack.append(Context(name))
-
-        self.generic_visit(node)
-
-        context = self._context_stack.pop()
-
-        if context.messages:
-            self._source.contexts.append(context)
-
-    def _get_current_context(self):
-        """ Return the current Context object if there is one. """
-
-        return self._context_stack[-1] if self._context_stack else None
-
-    @classmethod
-    def _get_first_str(cls, args):
-        """ Get the first of a list of arguments as a str. """
-
-        # Check that there is at least one argument.
-        if not args:
-            return None
-
-        return cls._get_str(args[0])
-
-    def _get_or_create_context(self, name):
-        """ Return the Context object for a name, creating it if necessary. """
-
-        for context in self._source.contexts:
-            if context.name == name:
-                return context
-
-        context = Context(name)
-        self._source.contexts.append(context)
-
-        return context
-
-    @staticmethod
-    def _get_str(node, allow_none=False):
-        """ Return the str from a node or None if it wasn't an appropriate
-        node.
-        """
-
-        if isinstance(node, ast.Str):
-            return node.s
-
-        if isinstance(node, ast.Constant):
-            if isinstance(node.value, str):
-                return node.value
-
-            if allow_none and node.value is None:
-                return ''
-
-        return None
-
-    def _parse_QT_TR_NOOP(self, node):
-        """ Parse the arguments to QT_TR_NOOP(). """
-
-        # Ignore unless there is a current context.
-        context = self._get_current_context()
-        if context is None:
-            return None
-
-        call_args = self._parse_noop_without_context(node.args, node.keywords)
-        if call_args is None:
-            return None
-
-        call_args.context = context
-
-        return call_args
-
-    def _parse_QT_TRANSLATE_NOOP(self, node):
-        """ Parse the arguments to QT_TRANSLATE_NOOP(). """
-
-        # Get the context.
-        name = self._get_first_str(node.args)
-        if name is None:
-            return None
-
-        call_args = self._parse_noop_without_context(node.args[1:], node.keywords)
-        if call_args is None:
-            return None
-
-        call_args.context = self._get_or_create_context(name)
-
-        return call_args
-
-    def _parse_tr(self, node):
-        """ Parse the arguments to tr(). """
-
-        # Ignore unless there is a current context.
-        context = self._get_current_context()
-        if context is None:
-            return None
-
-        call_args = self._parse_without_context(node.args, node.keywords)
-        if call_args is None:
-            return None
-
-        call_args.context = context
-
-        return call_args
-
-    def _parse_translate(self, node):
-        """ Parse the arguments to translate(). """
-
-        # Get the context.
-        name = self._get_first_str(node.args)
-        if name is None:
-            return None
-
-        call_args = self._parse_without_context(node.args[1:], node.keywords)
-        if call_args is None:
-            return None
-
-        call_args.context = self._get_or_create_context(name)
-
-        return call_args
-
-    def _parse_without_context(self, args, keywords):
-        """ Parse arguments for a message source and optional disambiguation
-        and n.
-        """
-
-        # The source is required.
-        source = self._get_first_str(args)
-        if source is None:
-            return None
-
-        if len(args) > 1:
-            disambiguation = self._get_str(args[1], allow_none=True)
-        else:
-            for kw in keywords:
-                if kw.arg == 'disambiguation':
-                    disambiguation = self._get_str(kw.value, allow_none=True)
-                    break
-            else:
-                disambiguation = ''
-
-        # Ignore if the disambiguation is specified but isn't a string.
-        if disambiguation is None:
-            return None
-
-        if len(args) > 2:
-            numerus = True
-        else:
-            numerus = 'n' in keywords
-
-        if len(args) > 3:
-            return None
-
-        return CallArguments(source, disambiguation, numerus)
-
-    def _parse_noop_without_context(self, args, keywords):
-        """ Parse arguments for a message source. """
-
-        # There must be exactly one positional argument.
-        if len(args) != 1 or len(keywords) != 0:
-            return None
-
-        source = self._get_str(args[0])
-        if source is None:
-            return None
-
-        return CallArguments(source)
-
-
-class CallArguments:
-    """ Encapsulate the possible arguments of a translation function. """
-
-    def __init__(self, source, disambiguation='', numerus=False):
-        """ Initialise the object. """
-
-        self.context = None
-        self.source = source
-        self.disambiguation = disambiguation
-        self.numerus = numerus

i18n/pylupdate6/source_file.py

@@ -1,29 +0,0 @@
-# Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
-#
-# This file is part of PyQt6.
-#
-# This file may be used under the terms of the GNU General Public License
-# version 3.0 as published by the Free Software Foundation and appearing in
-# the file LICENSE included in the packaging of this file.  Please review the
-# following information to ensure the GNU General Public License version 3.0
-# requirements will be met: http://www.gnu.org/copyleft/gpl.html.
-#
-# If you do not wish to use this file under the terms of the GPL version 3.0
-# then you may purchase a commercial license.  For more information contact
-# info@riverbankcomputing.com.
-#
-# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
-# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-
-class SourceFile:
-    """ The base class for any source file that provides translation contexts.
-    """
-
-    def __init__(self, filename, **kwargs):
-        """ Initialise the object. """
-
-        super().__init__(**kwargs)
-
-        self.filename = filename
-        self.contexts = []

i18n/pylupdate6/translation_file.py

@@ -1,390 +0,0 @@
-# Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
-#
-# This file is part of PyQt6.
-#
-# This file may be used under the terms of the GNU General Public License
-# version 3.0 as published by the Free Software Foundation and appearing in
-# the file LICENSE included in the packaging of this file.  Please review the
-# following information to ensure the GNU General Public License version 3.0
-# requirements will be met: http://www.gnu.org/copyleft/gpl.html.
-#
-# If you do not wish to use this file under the terms of the GPL version 3.0
-# then you may purchase a commercial license.  For more information contact
-# info@riverbankcomputing.com.
-#
-# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
-# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-
-import os
-from xml.etree import ElementTree
-
-from .user import User, UserException
-
-
-class TranslationFile(User):
-    """ Encapsulate a translation file. """
-
-    def __init__(self, ts_file, no_obsolete, no_summary, **kwargs):
-        """ Initialise the translation file. """
-
-        super().__init__(**kwargs)
-
-        if os.path.isfile(ts_file):
-            self.progress("Reading {0}...".format(ts_file))
-
-            try:
-                self._root = ElementTree.parse(ts_file).getroot()
-            except Exception as e:
-                raise UserException(
-                    "{}: {}: {}".format(ts_file, "invalid translation file", str(e))
-                )
-        else:
-            self._root = ElementTree.fromstring(_EMPTY_TS)
-
-        self._ts_file = ts_file
-        self._no_obsolete = no_obsolete
-        self._no_summary = no_summary
-        self._updated_contexts = {}
-
-        # Create a dict of contexts keyed by the context name and having the
-        # list of message elements as the value.
-        self._contexts = {}
-
-        # Also create a dict of existing translations so that they can be
-        # re-used.
-        self._translations = {}
-
-        context_els = []
-        for context_el in self._root:
-            if context_el.tag != 'context':
-                continue
-
-            context_els.append(context_el)
-
-            name = ''
-            message_els = []
-
-            for el in context_el:
-                if el.tag == 'name':
-                    name = el.text
-                elif el.tag == 'message':
-                    message_els.append(el)
-
-            if name:
-                self._contexts[name] = message_els
-
-                for message_el in message_els:
-                    source_el = message_el.find('source')
-                    if source_el is None or not source_el.text:
-                        continue
-
-                    translation_el = message_el.find('translation')
-                    if translation_el is None or not translation_el.text:
-                        continue
-
-                    self._translations[source_el.text] = translation_el.text
-
-        # Remove the context elements but keep everything else in the root
-        # (probably set by Linguist).
-        for context_el in context_els:
-            self._root.remove(context_el)
-
-        # Clear the summary statistics.
-        self._nr_new = 0
-        self._nr_new_duplicates = 0
-        self._nr_new_using_existing_translation = 0
-        self._nr_existing = 0
-        self._nr_kept_obsolete = 0
-        self._nr_discarded_obsolete = 0
-        self._nr_discarded_untranslated = 0
-
-        # Remember all new messages so we can make the summary less confusing
-        # than it otherwise might be.
-        self._new_message_els = []
-
-    def update(self, source):
-        """ Update the translation file from a SourceFile object. """
-
-        self.progress("Updating {0} from {1}...".format(self._ts_file, source.filename))
-
-        for context in source.contexts:
-            # Get the messages that we already know about for this context.
-            try:
-                message_els = self._contexts[context.name]
-            except KeyError:
-                message_els = []
-
-            # Get the messages that have already been updated.
-            updated_message_els = self._get_updated_message_els(context.name)
-
-            for message in context.messages:
-                message_el = self._find_message(message, message_els)
-
-                if message_el is not None:
-                    # Move the message to the updated list.
-                    message_els.remove(message_el)
-                    self._add_message_el(message_el, updated_message_els)
-                else:
-                    # See if this is a new message.  If not then we just have
-                    # another location for an existing message.
-                    message_el = self._find_message(message, updated_message_els)
-
-                if message_el is None:
-                    message_el = self._make_message_el(message)
-                    updated_message_els.append(message_el)
-
-                    self.progress("Added new message '{0}'".format(self.pretty(message.source)))
-                    self._nr_new += 1
-                else:
-                    self.progress("Updated message '{0}'".format(self.pretty(message.source)))
-
-                    # Don't count another copy of a new message as an existing
-                    # one.
-                    if message_el in self._new_message_els:
-                        self._nr_new_duplicates += 1
-                    else:
-                        self._nr_existing += 1
-
-                message_el.insert(0, self._make_location_el(message))
-
-    def write(self):
-        """ Write the translation file back to the filesystem. """
-
-        # If we are keeping obsolete messages then add them to the updated
-        # message elements list.
-        for name, message_els in self._contexts.items():
-            updated_message_els = None
-
-            for message_el in message_els:
-                source = self.pretty(message_el.find('source').text)
-
-                translation_el = message_el.find('translation')
-                if translation_el is not None and translation_el.text:
-                    if self._no_obsolete:
-                        self.progress("Discarded obsolete message '{0}'".format(source))
-                        self._nr_discarded_obsolete += 1
-                    else:
-                        translation_el.set('type', 'vanished')
-
-                        if updated_message_els is None:
-                            updated_message_els = self._get_updated_message_els(name)
-
-                        self._add_message_el(message_el, updated_message_els)
-
-                        self.progress("Kept obsolete message '{0}'".format(source))
-                        self._nr_kept_obsolete += 1
-                else:
-                    self.progress("Discarded untranslated message '{0}'".format(source))
-                    self._nr_discarded_untranslated += 1
-
-        # Created the sorted context elements.
-        for name in sorted(self._updated_contexts.keys()):
-            context_el = ElementTree.Element('context')
-
-            name_el = ElementTree.Element('name')
-            name_el.text = name
-            context_el.append(name_el)
-
-            context_el.extend(self._updated_contexts[name])
-
-            self._root.append(context_el)
-
-        self.progress("Writing {0}...".format(self._ts_file))
-        with open(self._ts_file, 'w', encoding='utf-8', newline='\n') as f:
-            f.write('<?xml version="1.0" encoding="utf-8"?>\n')
-            f.write('<!DOCTYPE TS>\n')
-
-            # Python v3.9 and later.
-            if hasattr(ElementTree, 'indent'):
-                ElementTree.indent(self._root)
-
-            ElementTree.ElementTree(self._root).write(f, encoding='unicode')
-            f.write('\n')
-
-        if not self._no_summary:
-            self._summary()
-
-    @staticmethod
-    def _add_message_el(message_el, updated_message_els):
-        """ Add a message element to a list of updated message elements. """
-
-        # Remove all the location elements.
-        for location_el in message_el.findall('location'):
-            message_el.remove(location_el)
-
-        # Add the message to the updated list.
-        updated_message_els.append(message_el)
-
-    @classmethod
-    def _find_message(cls, message, message_els):
-        """ Return the message element for a message from a list. """
-
-        for message_el in message_els:
-            source = ''
-            comment = ''
-            extra_comment = ''
-            extras = []
-
-            # Extract the data from the element.
-            for el in message_el:
-                if el.tag == 'source':
-                    source = el.text
-                elif el.tag == 'comment':
-                    comment = el.text
-                elif el.tag == 'extracomment':
-                    extra_comment = el.text
-                elif el.tag.startswith('extra-'):
-                    extras.append([el.tag[6:], el.text])
-
-            # Compare with the message.
-            if source != message.source:
-                continue
-
-            if comment != message.comment:
-                continue
-
-            if extra_comment != cls._get_message_extra_comments(message):
-                continue
-
-            if extras != message.embedded_comments.extras:
-                continue
-
-            return message_el
-
-        return None
-
-    @staticmethod
-    def _get_message_extra_comments(message):
-        """ Return a message's extra comments as they appear in a .ts file. """
-
-        return ' '.join(message.embedded_comments.extra_comments)
-
-    def _get_updated_message_els(self, name):
-        """ Return the list of updated message elements for a context. """
-
-        try:
-            updated_message_els = self._updated_contexts[name]
-        except KeyError:
-            updated_message_els = []
-            self._updated_contexts[name] = updated_message_els
-
-        return updated_message_els
-
-    def _make_location_el(self, message):
-        """ Return a 'location' element. """
-
-        return ElementTree.Element(
-            'location',
-            filename=os.path.relpath(
-                message.filename, start=os.path.dirname(os.path.abspath(self._ts_file))
-            ),
-            line=str(message.line_nr)
-        )
-
-    def _make_message_el(self, message):
-        """ Return a 'message' element. """
-
-        attrs = {}
-
-        if message.embedded_comments.message_id:
-            attrs['id'] = message.embedded_comments.message_id
-
-        if message.numerus:
-            attrs['numerus'] = 'yes'
-
-        message_el = ElementTree.Element('message', attrs)
-
-        source_el = ElementTree.Element('source')
-        source_el.text = message.source
-        message_el.append(source_el)
-
-        if message.comment:
-            comment_el = ElementTree.Element('comment')
-            comment_el.text = message.comment
-            message_el.append(comment_el)
-
-        if message.embedded_comments.extra_comments:
-            extracomment_el = ElementTree.Element('extracomment')
-            extracomment_el.text = self._get_message_extra_comments(message)
-            message_el.append(extracomment_el)
-
-        translation_el = ElementTree.Element('translation', type='unfinished')
-
-        # Try and find another message with the same source and use its
-        # translation if it has one.
-        translation = self._translations.get(message.source)
-        if translation:
-            translation_el.text = translation
-
-            self.progress("Reused existing translation for '{0}'".format(
-                self.pretty(message.source))
-            )
-            self._nr_new_using_existing_translation += 1
-
-        if message.numerus:
-            translation_el.append(ElementTree.Element('numerusform'))
-
-        message_el.append(translation_el)
-
-        for field, value in message.embedded_comments.extras:
-            el = ElementTree.Element('extra-' + field)
-            el.text = value
-            message_el.append(el)
-
-        self._new_message_els.append(message_el)
-
-        return message_el
-
-    def _summary(self):
-        """ Display the summary of changes to the user. """
-
-        summary_lines = []
-
-        # Display a line of the summary and the heading if not already done.
-        def summary(line):
-            nonlocal summary_lines
-
-            if not summary_lines:
-                summary_lines.append("Summary of changes to {ts}:".format(ts=self._ts_file))
-
-            summary_lines.append("    " + line)
-
-        if self._nr_new:
-            if self._nr_new_duplicates:
-                summary("{0} new messages were added (and {1} duplicates)".format(
-                        self._nr_new, self._nr_new_duplicates))
-            else:
-                summary("{0} new messages were added".format(self._nr_new))
-
-        if self._nr_new_using_existing_translation:
-            summary("{0} messages reused existing translations".format(
-                    self._nr_new_using_existing_translation))
-
-        if self._nr_existing:
-            summary("{0} existing messages were found".format(
-                    self._nr_existing))
-
-        if self._nr_kept_obsolete:
-            summary("{0} obsolete messages were kept".format(
-                    self._nr_kept_obsolete))
-
-        if self._nr_discarded_obsolete:
-            summary("{0} obsolete messages were discarded".format(
-                    self._nr_discarded_obsolete))
-
-        if self._nr_discarded_untranslated:
-            summary("{0} untranslated messages were discarded".format(
-                    self._nr_discarded_untranslated))
-
-        if not summary_lines:
-            summary_lines.append("{ts} was unchanged".format(ts=self._ts_file))
-
-        print(os.linesep.join(summary_lines))
-
-
-# The XML of an empty .ts file.  This is what a current lupdate will create
-# with an empty C++ source file.
-_EMPTY_TS = '''<TS version="2.1">
-</TS>
-'''

i18n/pylupdate6/translations.py

@@ -1,51 +0,0 @@
-# Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
-#
-# This file is part of PyQt6.
-#
-# This file may be used under the terms of the GNU General Public License
-# version 3.0 as published by the Free Software Foundation and appearing in
-# the file LICENSE included in the packaging of this file.  Please review the
-# following information to ensure the GNU General Public License version 3.0
-# requirements will be met: http://www.gnu.org/copyleft/gpl.html.
-#
-# If you do not wish to use this file under the terms of the GPL version 3.0
-# then you may purchase a commercial license.  For more information contact
-# info@riverbankcomputing.com.
-#
-# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
-# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-
-class Context:
-    """ Encapsulate a message context. """
-
-    def __init__(self, name):
-        """ Initialise the context. """
-
-        self.name = name
-        self.messages = []
-
-
-class EmbeddedComments:
-    """ Encapsulate information for a translator embedded in comments. """
-
-    def __init__(self):
-        """ Initialise the object. """
-
-        self.message_id = ''
-        self.extra_comments = []
-        self.extras = []
-
-
-class Message:
-    """ Encapsulate a message. """
-
-    def __init__(self, filename, line_nr, source, comment, numerus):
-        """ Initialise the message. """
-
-        self.filename = filename
-        self.line_nr = line_nr
-        self.source = source
-        self.comment = comment
-        self.numerus = numerus
-        self.embedded_comments = EmbeddedComments()

i18n/pylupdate6/user.py

@@ -1,47 +0,0 @@
-# Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
-#
-# This file is part of PyQt6.
-#
-# This file may be used under the terms of the GNU General Public License
-# version 3.0 as published by the Free Software Foundation and appearing in
-# the file LICENSE included in the packaging of this file.  Please review the
-# following information to ensure the GNU General Public License version 3.0
-# requirements will be met: http://www.gnu.org/copyleft/gpl.html.
-#
-# If you do not wish to use this file under the terms of the GPL version 3.0
-# then you may purchase a commercial license.  For more information contact
-# info@riverbankcomputing.com.
-#
-# This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
-# WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-
-class UserException(Exception):
-    """ Encapsulate an exception ultimate caused by the user. """
-
-    pass
-
-
-class User:
-    """ A mixin that provides methods for communicating with the user. """
-
-    def __init__(self, verbose, **kwargs):
-        """ Initialise the object. """
-
-        super().__init__(**kwargs)
-
-        self._verbose = verbose
-
-    @staticmethod
-    def pretty(text):
-        """ Returns a pretty-fied version of some text suitable for displaying
-        to the user.
-        """
-
-        return text.replace('\n', '\\n')
-
-    def progress(self, message):
-        """ Display a progress message. """
-
-        if self._verbose:
-            print(message)

i18n/qtbase.py

@@ -47,19 +47,3 @@ QT_TRANSLATE_NOOP("QPlatformTheme", "Help")
 QT_TRANSLATE_NOOP("QPlatformTheme", "Apply")
 QT_TRANSLATE_NOOP("QPlatformTheme", "Reset")
 QT_TRANSLATE_NOOP("QPlatformTheme", "Restore Defaults")
-
-# QWizard
-# =======
-
-QT_TRANSLATE_NOOP("QWizard", "Go Back")
-QT_TRANSLATE_NOOP("QWizard", "< &Back")
-QT_TRANSLATE_NOOP("QWizard", "Continue")
-QT_TRANSLATE_NOOP("QWizard", "&Next")
-QT_TRANSLATE_NOOP("QWizard", "&Next >")
-QT_TRANSLATE_NOOP("QWizard", "Commit")
-QT_TRANSLATE_NOOP("QWizard", "Done")
-QT_TRANSLATE_NOOP("QWizard", "&Finish")
-QT_TRANSLATE_NOOP("QWizard", "Cancel")
-QT_TRANSLATE_NOOP("QWizard", "Cancel")
-QT_TRANSLATE_NOOP("QWizard", "Help")
-QT_TRANSLATE_NOOP("QWizard", "&Help")