Release 2.2 Beta 1 (#1595)

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

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+# github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+# patreon: # Replace with a single Patreon username
+# open_collective: # Replace with a single Open Collective username
+ko_fi: jadzia626
+# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+# liberapay: # Replace with a single Liberapay username
+# issuehunt: # Replace with a single IssueHunt username
+# otechie: # Replace with a single Otechie username
+# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug-report.md

@@ -5,20 +5,12 @@ title: ""
 labels: bug
 ---
 
-**Describe the Bug**
-A clear and concise description of what the bug is.
+**Note**: Issues without a description will not be considered.
+Please also check if an issue already exists on this problem.
+Please provide a description covering the following points, if applicable:
 
-**To Reproduce**
-Steps to reproduce the behaviour:
-
-**Expected Behaviour**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Error Message**
-If the error dialog popped up, copy/paste the content here.
-
-**Additional Context**
-Add any other context about the problem here.
+* A clear and concise description of what the bug is.
+* Steps to reproduce the behaviour
+* A clear and concise description of what you expected to happen.
+* If applicable, add screenshots to help explain your problem.
+* If the error dialog popped up, copy/paste the content here.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -5,14 +5,11 @@ title: ""
 labels: enhancement
 ---
 
-**Is your feature request related to a problem? Please describe:**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Note**: Feature requests without a description will not be considered.
+Please also check if an issue already exists on this feature.
+Please provide a description covering the following points, if applicable:
 
-**Describe the solution you'd like:**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered:**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context:**
-Add any other context or screenshots about the feature request here.
+* A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
+* A clear and concise description of what you want to happen.
+* A clear and concise description of any alternative solutions or features you've considered.
+* If applicable, add screenshots to help explain your request.

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+<!--
+Please check the following before you make a pull request:
+
+* The branch you are making the pull request from (in your own fork) has a unique and descriptive
+  name. Do not make a pull request directly from your copy of `main`.
+* If you are submitting translation files, only submit the files that you have added translations
+  to, not the other .ts files that may have been updated in the process.
+* Make sure your contribution follows the style guide and other requirements mentioned in the
+  CONTRIBUTING.md file in the repository.
+* Fill in the Summary section below, and if relevant, mention the issue numbers related to the PR.
+-->
+
+**Summary:**
+
+**Related Issue(s):**
+
+**Reviewer's Checklist:**
+
+* [ ] The header of all files contain a reference to the repository license
+* [ ] The overall test coverage is increased or remains the same as before
+* [ ] All tests are passing
+* [ ] All flake8 checks are passing and the style guide is followed
+* [ ] Documentation (as docstrings) is complete and understandable
+* [ ] Only files that have been actively changed are committed

.github/workflows/build.yml

@@ -0,0 +1,103 @@
+name: Build
+
+on: workflow_dispatch
+
+jobs:
+  buildAssets:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          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@v3
+
+      - name: Install Packages (pip)
+        run: pip install -r docs/source/requirements.txt
+
+      - name: Build Assets
+        run: python pkgutils.py qtlrelease sample manual
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: nw-assets
+          path: |
+            novelwriter/assets/sample.zip
+            novelwriter/assets/manual.pdf
+            novelwriter/assets/i18n/*.qm
+          if-no-files-found: error
+          retention-days: 1
+
+  buildLinux:
+    needs: buildAssets
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+        linux-tag: ["manylinux_2_24_x86_64", "manylinux_2_28_x86_64"]
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          architecture: x64
+
+      - name: Install Packages (pip)
+        run: pip install python-appimage
+
+      - name: Checkout Source
+        uses: actions/checkout@v3
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: nw-assets
+          path: novelwriter/assets
+
+      - name: Build AppImage
+        run: python pkgutils.py build-appimage --linux-tag ${{ matrix.linux-tag }} --python-version ${{ matrix.python-version }}
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: novelWriter-Packages
+          path: |
+            dist_appimage/novelWriter*.AppImage
+            dist_appimage/novelWriter*.AppImage.sha256
+          if-no-files-found: error
+          retention-days: 1
+
+  buildMac:
+    needs: buildAssets
+    runs-on: macos-12
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: nw-assets
+          path: novelwriter/assets
+
+      - name: Build App Bundle
+        run: ./setup/macos/build.sh
+
+      - name: Upload DMG
+        uses: actions/upload-artifact@v3
+        with:
+          name: novelWriter-Packages
+          path: |
+            dist_macos/novelWriter*.dmg
+            dist_macos/novelWriter*.dmg.sha256
+          if-no-files-found: error
+          retention-days: 1

.github/workflows/syntax.yml

@@ -1,27 +1,30 @@
-name: Flake8 Checks
+name: Flake8
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
+      - dev
   pull_request:
-    branches: [ main ]
+    branches:
+      - main
+      - dev
 
 jobs:
   checkSyntax:
     runs-on: ubuntu-latest
     steps:
       - name: Python Setup
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3
           architecture: x64
-      - name: Checkout novelWriter
-        uses: actions/checkout@v2
+      - name: Checkout Source
+        uses: actions/checkout@v3
       - name: Install flake8
         run: pip install flake8
-      - name: Check for Syntax Error in novelWriter
-        run: flake8 nw --count --select=E9,F63,F7,F82 --show-source --statistics
-      - name: Check for Syntax Error in Tests
-        run: flake8 tests --count --select=E9,F63,F7,F82 --show-source --statistics
-      - name: Check for Code Style Violations
-        run: flake8 nw --count --max-line-length=99 --ignore E203,E221,E226,E241,E251,E261,E266,E302,E305 --show-source --statistics
+      - name: Syntax Check
+        run: |
+          flake8 --version
+          flake8 novelwriter --count --show-source --statistics
+          flake8 tests --count --show-source --statistics

.github/workflows/test_linux.yml

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

.github/workflows/test_mac.yml

@@ -0,0 +1,35 @@
+name: MacOS
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  testMac:
+    runs-on: macos-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          architecture: x64
+      - name: Install Packages (brew)
+        run: |
+          brew install enchant
+      - name: Checkout Source
+        uses: actions/checkout@v3
+      - name: Install Dependencies (pip)
+        run: |
+          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
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v3

.github/workflows/test_win.yml

@@ -0,0 +1,31 @@
+name: Windows
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  testWin:
+    runs-on: windows-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+          architecture: x64
+      - name: Checkout Source
+        uses: actions/checkout@v3
+      - name: Install Dependencies (pip)
+        run: |
+          pip install -U -r requirements.txt -r tests/requirements.txt
+      - name: Run Tests
+        run: |
+          pytest -v --cov=novelwriter --timeout=60
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v3

.gitignore

@@ -1,28 +1,46 @@
 # Setup/Install
 /MANIFEST
-/dist/
 /build/
 /deploy/
+/dist/
+/dist_*/
 *.spec
 *.egg-info
+setup.iss
+/novelwriter.desktop
+/novelWriter.pyw
+/setup/macos/Info.plist
+.venv
+
+# Translations
+/novelwriter/assets/i18n/*.qm
+.qmake.stash
+i18n/*.qm
+i18n/*.qph
 
 # Documentation
 /docs/build/
-novelWriter.qch
-novelWriter.qhc
+/novelwriter/assets/help/
+/novelwriter/assets/manual.pdf
+*.qch
+*.qhc
+.~lock.*
 
 # Python Temp
 __pycache__
+*.pyc
 
 # Sample Project
-/nw/assets/sample.zip
+/novelwriter/assets/sample.zip
 /sample/cache
 /sample/meta
 *.bak
 *.lock
+ToC.txt
 
 # PyTest
 /prof/
+/htmlcov/
 /tests/temp
 /tests/lipsum/cache
 /tests/lipsum/meta
@@ -31,3 +49,4 @@ __pycache__
 
 # Coverage
 /.coverage
+/coverage.*

.readthedocs.yml

@@ -1,25 +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:
-  version: 3.7
-  install:
-    - requirements: docs/source/requirements.txt

.travis.yml

@@ -1,57 +0,0 @@
-os: linux
-dist: focal
-services:
-  - xvfb
-language: python
-cache:
-  - bundler
-
-addons:
-  apt:
-    packages:
-      - libenchant-dev
-      - python3-pyqt5
-      - python3-pyqt5.qtsvg
-      - python3-lxml
-
-install:
-# - pip install --upgrade pip
-  - pip install -r requirements.txt
-  - pip install PyVirtualDisplay
-  - pip install pytest-cov
-  - pip install pytest-xvfb
-  - pip install pytest-qt
-  - pip install codecov
-
-stages:
-  - name: Main
-  - name: Supported
-# - name: Future
-#   if: branch = main
-
-jobs:
-  include:
-    - stage: Main
-      python: 3.8
-      script:
-      - python -m pytest --cov=nw -v
-      after_success:
-      - codecov
-      after_failure:
-      - cat /sys/fs/cgroup/memory/memory.max_usage_in_bytes
-
-    - stage: Supported
-      python: 3.6
-      script:
-      - python -m pytest -v
-
-    - python: 3.7
-      script:
-      - python -m pytest -v
-
-#   - stage:
-#     - Future
-#     python:
-#     - 3.9-dev
-#     script:
-#     - python -m pytest -v

CODE_OF_CONDUCT.md

@@ -2,75 +2,131 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project leader at issues (at) novelwriter.io. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement at issues (at)
+novelwriter.io. All complaints will be reviewed and investigated promptly and
+fairly.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
 [homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -1,103 +1,122 @@
-# Contributing
+# Contributing Guide
 
 When contributing to this repository, please first discuss the change you wish to make via the
-issue tracker with the owner of this repository before making a change. If you just want to make a
-minor correction, like fix a typo or similar, feel free to just make a pull request directly.
+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.
 
-There is a code of conduct. Please follow it in all your interactions with the project.
+The following contributions are welcome:
 
-## Pull Request Process
+* 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).
+* 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.
 
-1. Make sure your code passes all tests and conforms to the style guide. You can check that the code
-   conforms by running `flake8` from the root of the project folder.
-2. Please provide a complete description of the changes in the pull request, and a summary that can
-   be copied into the [CHANGELOG](CHANGELOG.md). Remember to reference any issue related by
-   providing the issue number.
-3. Do not change the version number unless asked to do so. Version numbers are bumped in separate
-   release pull requests by the maintainer.
+Please do not:
+
+* Make a pull request that restructures or reformats existing code. If you think some parts 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
+
+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.
+
+**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.
+
+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.
+* 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
+  mostly an issue with translation files. The language tool may update all files in the `i18n`
+  folder.
 
 ## Code of Conduct
 
+There is a code of conduct. Please follow it in all your interactions with the project.
+
 ### Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as contributors and maintainers
 pledge to making participation in our project and our community a harassment-free experience for
-everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level
-of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+everyone, regardless of age, body size, disability, ethnicity, gender identity and expression,
+level of experience, nationality, personal appearance, race, religion, or sexual identity and
+orientation.
 
 Please see the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file for the full text.
 
 ## Code Style Guide
 
-The source code of novelWriter broadly follows the [PEP8](https://www.python.org/dev/peps/pep-0008/)
-style guide , but with a few modifications and exceptions.
+The source code of novelWriter broadly follows the [PEP8](https://www.python.org/dev/peps/pep-0008)
+style guide, but with a few exceptions. Some key points are listed below.
 
-### Linting with flake8
+**Line Length:**
 
-An excellent tool for checking Python code for errors and coding style is `flake8`.
-The documentation is available [here](https://flake8.pycqa.org/en/latest/).
+* Source code lines can extend to the upper limit of 99 characters allowed by PEP8. 79 characters
+  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.
+* 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.
 
-The `setup.cfg` file in the root of this project has the following settings:
+**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 exception to the above is for constants. They should always be in upper snake case, like PEP8
+  states.
+
+**Spaces, Indentation and Alignment**
+
+* 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.
+* 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.
+
+### 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:
 ```conf
 [flake8]
-ignore = E203,E221,E226,E241,E251,E261,E266,E302,E305
+ignore = E133,E221,E226,E228,E241,W503
 max-line-length = 99
 exclude = docs/*
 ```
 
 The command line equivalent, with reporting, is:
 ```bash
-flake8 . --count --ignore E203,E221,E226,E241,E251,E261,E266,E302,E305 --max-line-length=99 --show-source --statistics
+flake8 . --count --ignore E133,E221,E226,E228,E241,W503 --max-line-length=99 --show-source --statistics
 ```
 
-Passing this check is required before contributuions are merged into the `main` branch. This is
-checked automatically when you make a pull request. You can run the `flake8` command locally to
-check beforehand. The full command will give you a detailed description of the code lines that do
-not conform to the standard.
+Passing this check is required before contributions are merged. This is checked automatically when
+you make a pull request. You can run the `flake8` command locally to check beforehand. The full
+command will give you a detailed description of the code lines that do not conform to the standard.
 
-## Ignored Errors
+Two of the ignored errors are due to the relaxed restriction on column alignment, these are the
+E221 and E241 error codes.
 
-Some errors are ignored in novelWriter, for various reasons. In addition, novelWriter sues camelCase
-function and variable names due to this being the standard for the Qt libraries, and also because of
-the author's personal preferences.
-
-The reason behind the other ignored error codes are listed below. Many of them are due to PEP8 not
-permitting column alignment as opposed to many other coding styles. I find them useful in regions of
-bulk value assignments. There's a reason why tables are more readable than lists. They should be
-used sparingly though.
-
-The ignored errors are all `pycodestyle` errors, and they are documented
-[here](https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes).
-
-**E203:** whitespace before ‘:’  
-**Reason:** Column alignment. It is natural to align dictionary columns along the `:` character,
-
-**E221:** multiple spaces before operator  
-**Reason:** Column alignment.
-
-**E226:** missing whitespace around arithmetic operator  
-**Reason:** This doesn't actually follow the PEP8 recommendation 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 `-`. For appending strings, the spaces can be
-dropped. Don't use the `+` operator for appending multiple strings. Use formatting instead.
-
-**E241:** multiple spaces after ‘,’  
-**Reason:** Column alignment.
-
-**E251:** unexpected spaces around keyword / parameter equals  
-**Reason:** Column alignment.
-
-**E261:** at least two spaces before inline comment  
-**Reason:** With syntax highlighting, this one is meaningless and wastes an extra space.
-
-**E266:** too many leading ‘#’ for block comment  
-**Reason:** In the source multiple `#`s to indicate importance levels is sometimes used, like
-markdown headers.
-
-**E302:** expected 2 blank lines, found 0  
-**Reason:** Applies to classes. Instead, end classes with a comment like `# END Class ClassName` to
-make it easier to se which class just ended. The double line break is then redundant.
-
-**E305:** expected 2 blank lines after end of function or class  
-**Reason:** Instead, _always_ end a function with a `return`, preferrably indented at function
-level. The end of the function is then clear.
+The code E226 is ignored becuse 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 `-`.
+The same applies to the modulo operator `%`, hence E228 is also ignored.

CREDITS.md

@@ -0,0 +1,64 @@
+# Credits
+
+## Main Developer
+
+* Veronica Berglyd Olsen (@vkbo)
+
+## Contributors
+
+* Concept: Marian Lückhof (@Number042)
+* Internationalisation: Bruno Meneguello (@bkmeneguello)
+* Setup and Packaging: Rachel Powers (@Ryex)
+
+For other contributions, see the project's [Contributors](https://github.com/vkbo/novelWriter/graphs/contributors) page.
+
+## Translations
+
+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)
+* Italian: Riccardo Mangili
+* Japanese: hebekeg (@hebekeg)
+* Latin American Spanish: Tommy Marplatt (@tmarplatt)
+* Norwegian: Veronica Berglyd Olsen (@vkbo)
+* Portuguese: Bruno Meneguello (@bkmeneguello)
+* Simplified Chinese: Qianzhi Long (@longqzh)
+
+Additional larger translation contributions:
+
+* French: Albert Aribaud (@aaribaud)
+
+Translations are managed on [Crowdin](https://crowdin.com/project/novelwriter), and more
+contributions are listed on the project's [Members](https://crowdin.com/project/novelwriter/members) page.
+
+## Libraries
+
+The following libraries are dependencies of novelWriter:
+
+* [Qt5](https://www.qt.io) by Qt Company
+* [PyQt5](https://www.riverbankcomputing.com/software/pyqt) by Riverbank Computing
+* [Enchant](https://abiword.github.io/enchant) by Dom Lachowicz
+* [PyEnchant](https://pyenchant.github.io/pyenchant) by Dimitri Merejkowsky
+
+## Assets
+
+Some of the assets bundled with novelWriter were adapted from the following sources:
+
+* [Typicons](https://github.com/stephenhutchings/typicons.font) icons by Stephen Hutchings (CC BY-SA 4.0)
+* [Tomorrow](https://github.com/chriskempson/base16) syntax themes by Chris Kempson (MIT License)
+* [Owl](https://github.com/sdras/night-owl-vscode-theme) syntax themes by Sarah Drasner (MIT License)
+* [Solarized](https://github.com/altercation/solarized) themes by Ethan Schoonover (MIT License)
+
+## Fonts
+
+The font used for the main novelWriter logo, mimetype and text banners is:
+
+* Pridi by Cadson Demak (Open Font License, Version 1.1)
+
+## Special Mentions
+
+Additional thanks to @johnblommers who was an early user and who has provided a lot of very useful
+feedback over the years.

MANIFEST.in

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

README.md

@@ -1,253 +1,68 @@
 # novelWriter
 
-[![Build Status](https://travis-ci.com/vkbo/novelWriter.svg?branch=main)](https://travis-ci.com/vkbo/novelWriter)
-[![codecov](https://codecov.io/gh/vkbo/novelWriter/branch/main/graph/badge.svg)](https://codecov.io/gh/vkbo/novelWriter)
-[![Documentation Status](https://readthedocs.org/projects/novelwriter/badge/?version=latest)](https://novelwriter.readthedocs.io/en/latest/?badge=latest)
-[![Flake8 Checks](https://github.com/vkbo/novelWriter/workflows/Flake8%20Checks/badge.svg)](https://github.com/vkbo/novelWriter/actions)
-[![PyPI](https://img.shields.io/pypi/v/novelwriter)](https://pypi.org/project/novelWriter/)
-[![Python Version](https://img.shields.io/pypi/pyversions/novelwriter)](https://pypi.org/project/novelWriter/)
+[![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)
 
-<img align="left" style="margin: 0 16px 4px 0;" src="https://raw.githubusercontent.com/vkbo/novelWriter/main/assets/icons/96x96/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 markdown-like text editor designed for writing novels and larger projects of many
-smaller plain text documents. It uses its own flavour of markdown that supports a meta data syntax
-for comments, synopsis and cross-referencing between files. It's designed to be a simple text editor
-which allows for easy organisation of text files and notes, built on plain text files for
-robustness.
+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
+for comments, synopsis, and cross-referencing. It's 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.
 
-The plain text storage is suitable for version control software, and also well suited for file
-synchronisation tools. The core project structure is stored in a project XML file. Other meta data
-is primarily saved in JSON files.
+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.
 
-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 contributing guide is available in [CONTRIBUTING](CONTRIBUTING.md).
-
-
-### Note on the Default Branch
-
-The default branch on this repository switched to `main` on 6. August 2020. If you are running
-novelWriter from a git clone, you need to clone the repository again.
-
-Alternatively, you can run the following to get back on the main branch:
-
-```bash
-git remote update
-git checkout -t origin/main
-```
-
-
-### Development Status
-
-The application is still under initial development, but all core features have now been added. The
-core functionality has been in place for a while, and novelWriter is being used for writing projects
-by the author and collaborators.
-
-No new major features will be added at this time, until the application is stable. Until then,
-novelWriter is in a _beta_ state. Please report any issues you may encounter in the repository issue
-tracker.
-
-You should be able to use novelWriter for real projects, but as with all software, please make
-regular backups. There is a built in backup feature that can pack the entire project into a zip file
-on close. Please check the documentation for further details.
-
-
-## License
-
-This is Open Source software, and novelWriter is licensed 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](LICENSE.md) file.
-
-Bundled assets have the following licenses:
-
-* The Typicon-based icon themes by Stephen Hutchings are licensed under
-  [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/). The icons have been altered in
-  size and colour for use with novelWriter, and some additional icons added. The original icon set
-  is available at [stephenhutchings/typicons.font](https://github.com/stephenhutchings/typicons.font).
-* The Cantarell font by Dave Crossland is licensed under [OPEN FONT LICENSE Version 1.1](http://scripts.sil.org/OFL).
-  It is available at [Google Fonts](https://fonts.google.com/specimen/Cantarell).
-* The Tomorrow syntax themes use colour schemes taken from Chris Kempson's collection of code editor
-  themes, licensed with the [MIT License](https://github.com/chriskempson/tomorrow-theme/blob/master/LICENSE.md),
-  and the main repo is available at [chriskempson/tomorrow-theme](https://github.com/chriskempson/tomorrow-theme).
-* Likewise, the Owl syntax themes use colours from Sarah Drasner's code editor themes, licensed with
-  the [MIT License](https://github.com/sdras/night-owl-vscode-theme/blob/master/LICENSE), and the
-  main repo is available at [sdras/night-owl-vscode-theme](https://github.com/sdras/night-owl-vscode-theme).
-
-
-## Markdown Flavour
-
-novelWriter is _not_ a full-feature Markdown editor. It allows for a minimal set of formatting
-needed for writing text documents for novels. These are currently limited to:
-
-* Headings level 1 to 4 using the `#` syntax only.
-* Emphasised, strong text. These are rendered as italicised and bold.
-* Strikethrough text.
-* Hard line breaks using two or more spaces at the end of a line.
-
-That is it. Features not supported in the editor are also not exported when using the export tool.
-
-In addition, novelWriter adds the following, which is otherwise not supported by Markdown:
-
-* A line starting with `%` is treated as a comment and not rendered on exports unless requested.
-  Comments do not count towards the word count. If the first word of the comment is `synopsis:`, the
-  comment is indexed and treated as the synopsis for the following section of text. These synopsis
-  comments can be used to build an outline and exported to external documents.
-* A set of meta data keyword/value sets starting with the character `@`. This is used for tagging
-  and inter-linking documents.
-* Non-breaking spaces are supported as long as your system is using at least Qt 5.9. For earlier
-  version, non-breaking spaces are converted to normal spaces when saving the document. This is done
-  by the Qt library.
-* Thin spaces are also supported, as well as non-breaking thin spaces.
-* Tabs may be rendered, depending on export format. With Qt 5.10 or higher, the width of a tab in
-  pixels can be changed in Preferences.
-
-The core export format of novelWriter is HTML5. You can also export the entire project as a single
-novelWriter flavour document. In addition, other exports to Open Document, PDF, and plain text is
-offered through the Qt library, although with limitations to formatting.
+**Project Links**
 
+* 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)
 
 ## Implementation
 
-The application is written in Python3 using Qt5 via PyQt5. It is developed on Linux, but it should
-in principle work fine on other operating systems as well as long as dependencies are met. It is
-regularly tested on Windows 10.
+novelWriter is written with Python 3 (3.8+) using Qt5 and PyQt5 (5.10+), and is released on Linux,
+Windows and macOS. It can in principle run on any Operating System that also supports Qt, PyQt and
+Python.
 
-The application can be started from the source folder with one of the commands:
-```
-./novelWriter.py
-python novelWriter.py
-python3 novelWriter.py
-```
+## Project Contributions
 
-It also takes a few parameters for debugging and such, which can be listed with the switch `--help`.
+Please don't make feature pull requests without first having discussed them with the maintainer.
+You can make a feature request in the issue tracker, or if the idea isn't fully formed, start a
+discussion on the discussion page. Please also don't make pull requests to reformat or rewrite
+existing code unless there is a very good reason for doing so.
 
-In the root assets folder there are icons and scripts and a template for setting up a launcher on
-Gnome desktops. You may need to modify those scripts slightly, but as they are, they work on Debian
-and Ubuntu. For other operating systems, please consult your operating system documentation for how
-to make those. Feel free to submit more if you are able to make them.
+Fixes and patches are welcome. Contributions related to packaging and installing novelWriter will
+also be appreciated, but please make an issue or a discussion topic first. Before contributing any
+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).
 
-## Package Dependencies
+### Translations
 
-It is recommended that novelWriter runs with Qt 5.10 or later, and Python 3.6 or later. Running with
-Qt as low as 5.2.1 and Python 3.4.3 has been tested, and worked in the past, but there are no
-guarantees that this will keep working as these are not a part of the test builds.
+New translations are always welcome. This project uses Crowdin to maintain translations, and you
+can contribute translations at the [Crowdin project page](https://crowdin.com/project/novelwriter).
+If you have any questions, feel free to post them to the
+[Translations of novelWriter](https://github.com/vkbo/novelWriter/issues/93) issue thread.
 
-For the apt package manager on Debian systems, the following Python3 packages are needed:
+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).
 
-* `python3-pyqt5` for the GUI
-* `python3-pyqt5.qtsvg` may need to be installed separately
-* `python3-lxml` for writing project files
+## Licence
 
-These are optional, but recommended:
-
-* `python3-enchant` for better spell checking
-
-Alternatively, the packages can be installed with `pip` by running
-```bash
-pip install -r requirements.txt
-```
-
-in the application folder.
-
-You can also do them one at a time, skipping the ones you don't need:
-```bash
-pip install pyqt5
-pip install lxml
-pip install pyenchant
-```
-
-PyQt/Qt should be at least 5.3, but ideally 5.10 or higher for nearly all features to work.
-Exporting to markdown requires PyQt/Qt 5.14. There are no known minimum for `lxml`, but the code
-was originally written with 4.2. The optional spell check library must be at least 3.0.0 to work
-with Windows 64 bit systems. On Linux, 2.0.0 also works fine.
-
-If no external spell checking tool is installed, novelWriter will use a basic spell checker based on
-standard Python package `difflib`. Currently, only English dictionaries are available for this spell
-checker, but more can be added to the `nw/assets/dict` folder. See the [README](nw/assets/dict/README.md)
-file in that folder for how to generate more dictionaries. Note that the difflib-based option is
-both slow and limited.
-
-Note: On Windows, make sure Python3 is in your PATH if you want to launch novelWriter from command
-line. You can also right click the `novelWriter.py` file, create a shortcut, then right click again,
-select "Properties" and change the target to your python executable and `novelWriter.py`.
-
-It should look something like this:
-```
-C:\...\AppData\Local\Programs\Python\Python38\python.exe novelWriter.py
-```
-
-## Key Features
-
-Some features of novelWriter are listed below. Consult the documentation for more information.
-
-
-### Colour Themes
-
-The editor has syntax highlighting for the features it supports, and includes a set of different
-syntax highlighting themes. The GUI also has an optional dark theme in addition to the default
-system theme.
-
-New themes can easily be added to the `nw/assets/themes` folder. Have a look in the existing folders
-for examples of how to define the colours.
-
-
-### Auto-Saving and Document Stats
-
-Open documents and the project file itself is saved regularly on a timer. The status of this is
-indicated by two indicators on the right hand side of the status bar. Latest project word count is
-shown next to these indicators in the status bar. The counts are updated regularly, but not
-as-you-type.
-
-The word count for documents is presented in a footer in the document editor itself. Both project
-and document word counters will also show how many words you've added in the current writing
-session.
-
-
-### Easy Organising of Project Files
-
-The structure of the project is shown on the left hand side of the main GUI. 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 makes up the finished novel. Each root
-folder can have subfolders. Folders have no impact on the project structure, they are purely tools
-for organising the files in whatever way the user needs.
-
-The editor supports four levels of headings, which determines 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 separate sections.
-
-Each novel file can be assigned a layout format, which shows up as a flag next to the item in the
-project tree. These are mostly to help the user see what they contain, but they also have some
-impact on the format of the exported document. See the documentation for further details.
-
-
-#### Project Notes
-
-Supporting note files can be added for the story plot, characters, locations, story timeline, etc.
-These have their separate root folders. These are optional files.
-
-
-### Visualisation of Story Elements
-
-The different notes can be assigned tags, which other files can refer back to using special 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 editing.
-
-
-## Contribution
-
-If you want to contribute to novelWriter, please follow the coding convention laid out in the
-[Style Guide](markdown/style.md). They broadly follow Python PEP8, but there are a few
-modifications.
-
-
-## Screenshot
-
-**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)
+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)
+document. Bundled assets and their licences are listed in the
+[Credits](https://github.com/vkbo/novelWriter/blob/main/CREDITS.md) document.

assets/icons/novelwriter.svg

@@ -1,184 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:xlink="http://www.w3.org/1999/xlink"
-   id="svg8"
-   version="1.1"
-   viewBox="0 0 270.93333 270.93334"
-   height="1024"
-   width="1024">
-  <defs
-     id="defs2">
-    <linearGradient
-       id="linearGradient1470">
-      <stop
-         style="stop-color:#7a9cb8;stop-opacity:1"
-         offset="0"
-         id="stop1466" />
-      <stop
-         style="stop-color:#5978a6;stop-opacity:1"
-         offset="1"
-         id="stop1468" />
-    </linearGradient>
-    <rect
-       x="60.484347"
-       y="205.79962"
-       width="130.57787"
-       height="65.785888"
-       id="rect852" />
-    <rect
-       id="rect1474"
-       height="28.631245"
-       width="177.70083"
-       y="18.019813"
-       x="13.463703" />
-    <rect
-       id="rect852-7"
-       height="65.785889"
-       width="130.57787"
-       y="205.79962"
-       x="60.484348" />
-    <rect
-       id="rect1544"
-       height="65.785889"
-       width="130.57787"
-       y="205.79962"
-       x="60.484348" />
-    <rect
-       x="60.484348"
-       y="205.79962"
-       width="130.57787"
-       height="65.785889"
-       id="rect1570" />
-    <rect
-       x="13.463703"
-       y="18.019813"
-       width="177.70083"
-       height="28.631245"
-       id="rect1587" />
-    <filter
-       style="color-interpolation-filters:sRGB;"
-       id="filter1444">
-      <feFlood
-         flood-opacity="0.498039"
-         flood-color="rgb(0,0,0)"
-         result="flood"
-         id="feFlood1434" />
-      <feComposite
-         in="flood"
-         in2="SourceGraphic"
-         operator="in"
-         result="composite1"
-         id="feComposite1436" />
-      <feGaussianBlur
-         in="composite1"
-         stdDeviation="3"
-         result="blur"
-         id="feGaussianBlur1438" />
-      <feOffset
-         dx="6"
-         dy="6"
-         result="offset"
-         id="feOffset1440" />
-      <feComposite
-         in="SourceGraphic"
-         in2="offset"
-         operator="over"
-         result="composite2"
-         id="feComposite1442" />
-    </filter>
-    <filter
-       style="color-interpolation-filters:sRGB;"
-       id="filter1456">
-      <feFlood
-         flood-opacity="0.498039"
-         flood-color="rgb(0,0,0)"
-         result="flood"
-         id="feFlood1446" />
-      <feComposite
-         in="flood"
-         in2="SourceGraphic"
-         operator="in"
-         result="composite1"
-         id="feComposite1448" />
-      <feGaussianBlur
-         in="composite1"
-         stdDeviation="3"
-         result="blur"
-         id="feGaussianBlur1450" />
-      <feOffset
-         dx="6"
-         dy="6"
-         result="offset"
-         id="feOffset1452" />
-      <feComposite
-         in="SourceGraphic"
-         in2="offset"
-         operator="over"
-         result="composite2"
-         id="feComposite1454" />
-    </filter>
-    <radialGradient
-       xlink:href="#linearGradient1470"
-       id="radialGradient1474"
-       cx="111.19364"
-       cy="67.111206"
-       fx="111.19364"
-       fy="67.111206"
-       r="130.96873"
-       gradientUnits="userSpaceOnUse"
-       gradientTransform="matrix(2.2584252,1.5089457,-0.74487144,1.1148423,-169.6027,-163.93817)" />
-  </defs>
-  <metadata
-     id="metadata5">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <g
-     style="display:inline"
-     id="layer1">
-    <rect
-       ry="21.166666"
-       rx="21.166666"
-       y="5.8208332"
-       x="5.8208332"
-       height="259.29166"
-       width="259.29166"
-       id="rect1467"
-       style="display:inline;fill:url(#radialGradient1474);fill-opacity:1;stroke:#517995;stroke-width:2.64583;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
-  </g>
-  <g
-     id="layer2"
-     style="display:inline">
-    <path
-       id="rect1406"
-       style="fill:#a11212;fill-opacity:1;stroke:#7e1b1b;stroke-width:9.99999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;filter:url(#filter1444)"
-       d="m 312,200 c -44.32,0 -80,35.68 -80,80 v 199.99805 a 279.99999,279.99999 0 0 0 0,0.002 279.99999,279.99999 0 0 0 0,0.0195 v 199.98242 c 0,44.31999 35.68,80 80,80 44.32,0 80,-35.68001 80,-80 v -200 a 120,120 0 0 1 120,-120 120,120 0 0 1 120,120 V 762.83789 H 792 V 480.00195 a 279.99999,279.99999 0 0 0 -280,-280 279.99999,279.99999 0 0 0 -0.81055,0 279.99999,279.99999 0 0 0 -133.46484,34.29688 C 363.30011,213.54621 339.29632,200 312,200 Z m 231.46094,563.22656 c -0.62174,0.0972 -1.2172,0.22317 -1.7793,0.37696 0.5621,-0.15379 1.15756,-0.27973 1.7793,-0.37696 z m -1.7793,0.37696 c -0.5621,0.15378 -1.09071,0.33534 -1.58008,0.53906 0.48937,-0.20372 1.01798,-0.38528 1.58008,-0.53906 z m 338.85742,-0.37696 c 0.62174,0.0972 1.2172,0.22317 1.7793,0.37696 -0.5621,-0.15379 -1.15756,-0.27973 -1.7793,-0.37696 z m 1.7793,0.37696 c 0.5621,0.15378 1.09071,0.33534 1.58008,0.53906 -0.48938,-0.20372 -1.01798,-0.38528 -1.58008,-0.53906 z"
-       transform="scale(0.26458333)" />
-    <path
-       id="path897"
-       style="display:inline;fill:#730d0d;fill-opacity:1;stroke:#590d0d;stroke-width:9.99999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;filter:url(#filter1456)"
-       d="m 632,762.83789 v 0.16406 h -85.58398 c -5.49302,0 -9.91602,2.2329 -9.91602,5.00586 0,0.52294 0.15913,1.02696 0.45117,1.5 h -0.44531 c 0.30916,2.03607 1.24102,3.99791 2.81641,5.57227 l 165.59961,165.49414 c 3.92061,3.91808 10.23371,3.91812 14.15429,0 L 884.67773,775.08008 c 1.57569,-1.57463 2.50725,-3.53578 2.81641,-5.57227 h -0.44531 c 0.29216,-0.47304 0.45117,-0.97706 0.45117,-1.5 0,-2.77296 -4.42304,-5.00586 -9.91602,-5.00586 H 792 v -0.16406 z"
-       transform="scale(0.26458333)" />
-    <rect
-       style="fill:#c32222;fill-opacity:1;stroke:none;stroke-width:2.64583;stroke-linejoin:round;stroke-opacity:1"
-       id="rect914"
-       width="10.583333"
-       height="119.0625"
-       x="69.849998"
-       y="67.997917"
-       rx="5.2916665"
-       ry="5.2916665" />
-  </g>
-</svg>

assets/icons/x-novelwriter-project.svg

@@ -1,207 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
-   xmlns:dc="http://purl.org/dc/elements/1.1/"
-   xmlns:cc="http://creativecommons.org/ns#"
-   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-   xmlns:svg="http://www.w3.org/2000/svg"
-   xmlns="http://www.w3.org/2000/svg"
-   xmlns:xlink="http://www.w3.org/1999/xlink"
-   id="svg8"
-   version="1.1"
-   viewBox="0 0 270.93333 270.93334"
-   height="1024"
-   width="1024">
-  <defs
-     id="defs2">
-    <linearGradient
-       id="linearGradient2515">
-      <stop
-         style="stop-color:#f7f7f7;stop-opacity:1"
-         offset="0"
-         id="stop2511" />
-      <stop
-         style="stop-color:#e5e5e5;stop-opacity:1"
-         offset="1"
-         id="stop2513" />
-    </linearGradient>
-    <rect
-       x="60.484347"
-       y="205.79962"
-       width="130.57787"
-       height="65.785888"
-       id="rect852" />
-    <rect
-       id="rect1474"
-       height="28.631245"
-       width="177.70083"
-       y="18.019813"
-       x="13.463703" />
-    <rect
-       id="rect852-7"
-       height="65.785889"
-       width="130.57787"
-       y="205.79962"
-       x="60.484348" />
-    <rect
-       id="rect1544"
-       height="65.785889"
-       width="130.57787"
-       y="205.79962"
-       x="60.484348" />
-    <rect
-       x="60.484348"
-       y="205.79962"
-       width="130.57787"
-       height="65.785889"
-       id="rect1570" />
-    <rect
-       x="13.463703"
-       y="18.019813"
-       width="177.70083"
-       height="28.631245"
-       id="rect1587" />
-    <filter
-       id="filter1444"
-       style="color-interpolation-filters:sRGB">
-      <feFlood
-         id="feFlood1434"
-         result="flood"
-         flood-color="rgb(0,0,0)"
-         flood-opacity="0.498039" />
-      <feComposite
-         id="feComposite1436"
-         result="composite1"
-         operator="in"
-         in2="SourceGraphic"
-         in="flood" />
-      <feGaussianBlur
-         id="feGaussianBlur1438"
-         result="blur"
-         stdDeviation="3"
-         in="composite1" />
-      <feOffset
-         id="feOffset1440"
-         result="offset"
-         dy="6"
-         dx="6" />
-      <feComposite
-         id="feComposite1442"
-         result="composite2"
-         operator="over"
-         in2="offset"
-         in="SourceGraphic" />
-    </filter>
-    <filter
-       id="filter1456"
-       style="color-interpolation-filters:sRGB">
-      <feFlood
-         id="feFlood1446"
-         result="flood"
-         flood-color="rgb(0,0,0)"
-         flood-opacity="0.498039" />
-      <feComposite
-         id="feComposite1448"
-         result="composite1"
-         operator="in"
-         in2="SourceGraphic"
-         in="flood" />
-      <feGaussianBlur
-         id="feGaussianBlur1450"
-         result="blur"
-         stdDeviation="3"
-         in="composite1" />
-      <feOffset
-         id="feOffset1452"
-         result="offset"
-         dy="6"
-         dx="6" />
-      <feComposite
-         id="feComposite1454"
-         result="composite2"
-         operator="over"
-         in2="offset"
-         in="SourceGraphic" />
-    </filter>
-    <radialGradient
-       xlink:href="#linearGradient2515"
-       id="radialGradient2517"
-       cx="605.42725"
-       cy="623.97186"
-       fx="605.42725"
-       fy="623.97186"
-       r="410"
-       gradientTransform="matrix(2.4110274,1.7617596,-0.719517,0.98463462,-776.23441,-1372.7537)"
-       gradientUnits="userSpaceOnUse" />
-  </defs>
-  <metadata
-     id="metadata5">
-    <rdf:RDF>
-      <cc:Work
-         rdf:about="">
-        <dc:format>image/svg+xml</dc:format>
-        <dc:type
-           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
-        <dc:title></dc:title>
-      </cc:Work>
-    </rdf:RDF>
-  </metadata>
-  <g
-     id="layer3"
-     style="display:inline">
-    <path
-       clip-path="none"
-       transform="scale(0.26458333)"
-       d="m 192,22 c -44.32,0 -80,35.680002 -80,80 v 820 c 0,44.32002 35.68,80 80,80 h 640 c 44.31999,0 80,-35.67998 80,-80 V 213.44727 L 720.55469,22 Z"
-       style="fill:url(#radialGradient2517);fill-opacity:1;stroke:#999999;stroke-width:20;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-       id="rect1481" />
-    <path
-       id="path1490"
-       style="display:inline;fill:#e0e0e0;fill-opacity:1;stroke:#999999;stroke-width:5.29167;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
-       d="M 241.30037,56.474215 190.64713,5.8204593 V 35.307549 c 0,11.726333 9.44034,21.166666 21.16667,21.166666 z" />
-    <g
-       aria-label=".nwx"
-       transform="matrix(1.7893481,0,0,1.782571,-45.41919,-191.90571)"
-       id="text850"
-       style="font-size:5.64444px;line-height:1.25;font-family:'Fira Sans';-inkscape-font-specification:'Fira Sans, Normal';letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect852);display:inline;fill:#666666;fill-opacity:1">
-      <path
-         d="m 63.088865,241.76928 q 0,-1.36426 0.909505,-2.27376 0.930175,-0.93018 2.480467,-0.93018 1.550291,0 2.459796,0.93018 0.909504,0.9095 0.909504,2.27376 0,1.34359 -0.909504,2.27376 -0.909505,0.9095 -2.459796,0.9095 -1.550292,0 -2.480467,-0.9095 -0.909505,-0.93017 -0.909505,-2.27376 z"
-         style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:42.3333px;font-family:Roboto;-inkscape-font-specification:'Roboto, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#666666;fill-opacity:1"
-         id="path856" />
-      <path
-         d="m 84.75161,226.78312 q -2.542479,0 -3.782712,2.14974 v 15.79231 h -5.973791 v -22.36554 h 5.601721 l 0.206705,2.56314 q 2.397785,-2.97656 6.428544,-2.97656 3.162595,0 5.105627,1.88103 1.943033,1.88102 1.963703,6.55256 v 14.34537 h -5.994461 v -14.26269 q 0,-2.14973 -0.930175,-2.91454 -0.909505,-0.76482 -2.625161,-0.76482 z"
-         style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:42.3333px;font-family:Roboto;-inkscape-font-specification:'Roboto, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#666666;fill-opacity:1"
-         id="path858" />
-      <path
-         d="m 126.96089,222.35963 -5.68441,22.36554 h -5.00227 l -4.25814,-14.07665 -4.23746,14.07665 h -4.9816 l -5.705078,-22.36554 h 5.767088 l 2.95589,14.22134 4.05143,-14.22134 h 4.32014 l 4.09277,14.20067 2.91455,-14.20067 z"
-         style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:42.3333px;font-family:Roboto;-inkscape-font-specification:'Roboto, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#666666;fill-opacity:1"
-         id="path860" />
-      <path
-         d="m 134.77436,222.35963 3.65869,6.65592 3.76204,-6.65592 h 6.3872 l -6.36653,10.93472 6.63525,11.43082 h -6.3872 l -4.01009,-7.04866 -3.94808,7.04866 h -6.42854 l 6.63525,-11.43082 -6.36654,-10.93472 z"
-         style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:42.3333px;font-family:Roboto;-inkscape-font-specification:'Roboto, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#666666;fill-opacity:1"
-         id="path862" />
-    </g>
-  </g>
-  <g
-     id="g2509"
-     transform="matrix(1.2371037,0,0,1.2371037,206.3182,37.341857)">
-    <path
-       transform="matrix(0.16895991,0,0,0.18329422,-134.6942,-19.491243)"
-       id="rect1406-1"
-       style="display:inline;fill:#a11212;fill-opacity:1;stroke:#7e1b1b;stroke-width:9.99999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;filter:url(#filter1444)"
-       d="m 145.18984,56.414257 c -44.32,0 -79.999998,35.68 -79.999998,80.000003 v 199.99805 a 279.99999,279.99999 0 0 0 0,0.002 279.99999,279.99999 0 0 0 0,0.0195 v 199.98242 c 0,44.31999 35.679998,80 79.999998,80 44.32,0 80,-35.68001 80,-80 v -200 a 120,120 0 0 1 120,-120 120,120 0 0 1 120,120 v 282.83592 h 160 V 336.41621 a 279.99999,279.99999 0 0 0 -280,-280.000003 279.99999,279.99999 0 0 0 -0.81055,0 279.99999,279.99999 0 0 0 -133.46484,34.29688 c -14.4245,-20.75262 -38.42829,-34.29883 -65.72461,-34.29883 z M 376.65078,619.64082 c -0.62174,0.0972 -1.2172,0.22317 -1.7793,0.37696 0.5621,-0.15379 1.15756,-0.27973 1.7793,-0.37696 z m -1.7793,0.37696 c -0.5621,0.15378 -1.09071,0.33534 -1.58008,0.53906 0.48937,-0.20372 1.01798,-0.38528 1.58008,-0.53906 z m 338.85742,-0.37696 c 0.62174,0.0972 1.2172,0.22317 1.7793,0.37696 -0.5621,-0.15379 -1.15756,-0.27973 -1.7793,-0.37696 z m 1.7793,0.37696 c 0.5621,0.15378 1.09071,0.33534 1.58008,0.53906 -0.48938,-0.20372 -1.01798,-0.38528 -1.58008,-0.53906 z" />
-    <path
-       transform="matrix(0.16895991,0,0,0.18329422,-134.6942,-19.491243)"
-       id="path897"
-       style="display:inline;fill:#730d0d;fill-opacity:1;stroke:#590d0d;stroke-width:9.99999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;filter:url(#filter1456)"
-       d="m 465.18984,619.25215 v 0.16406 h -85.58398 c -5.49302,0 -9.91602,2.2329 -9.91602,5.00586 0,0.52294 0.15913,1.02696 0.45117,1.5 h -0.44531 c 0.30916,2.03607 1.24102,3.99791 2.81641,5.57227 l 165.59961,165.49414 c 3.92061,3.91808 10.23371,3.91812 14.15429,0 L 717.86757,631.49434 c 1.57569,-1.57463 2.50725,-3.53578 2.81641,-5.57227 h -0.44531 c 0.29216,-0.47304 0.45117,-0.97706 0.45117,-1.5 0,-2.77296 -4.42304,-5.00586 -9.91602,-5.00586 h -85.58398 v -0.16406 z" />
-    <rect
-       style="display:inline;fill:#c32222;fill-opacity:1;stroke:none;stroke-width:1.75982;stroke-linejoin:round;stroke-opacity:1"
-       id="rect914"
-       width="6.7583966"
-       height="82.482399"
-       x="-118.27303"
-       y="1.2969339"
-       rx="3.3791983"
-       ry="3.6658845" />
-  </g>
-</svg>

assets/installDebian.sh

@@ -1,49 +0,0 @@
-#!/bin/bash
-
-cd ..
-
-EXEC=$(pwd)/novelWriter.py
-EXEC=$(echo $EXEC | sed 's_/_\\/_g')
-
-sed "s/%%exec%%/$EXEC/g" assets/novelwriter.desktop > /usr/share/applications/novelwriter.desktop
-
-if [ ! -d /usr/share/icons/hicolor/24x24/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/24x24/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/48x48/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/48x48/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/96x96/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/96x96/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/256x256/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/256x256/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/512x512/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/512x512/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/scalable/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/scalable/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/scalable/mimetypes ]; then
-    mkdir -pv /usr/share/icons/hicolor/scalable/mimetypes
-fi
-
-cp -v assets/icons/24x24/novelwriter.png     /usr/share/icons/hicolor/24x24/apps/
-cp -v assets/icons/48x48/novelwriter.png     /usr/share/icons/hicolor/48x48/apps/
-cp -v assets/icons/96x96/novelwriter.png     /usr/share/icons/hicolor/96x96/apps/
-cp -v assets/icons/256x256/novelwriter.png   /usr/share/icons/hicolor/256x256/apps/
-cp -v assets/icons/512x512/novelwriter.png   /usr/share/icons/hicolor/512x512/apps/
-cp -v assets/icons/novelwriter.svg           /usr/share/icons/hicolor/scalable/apps/
-cp -v assets/icons/x-novelwriter-project.svg /usr/share/icons/hicolor/scalable/mimetypes/application-x-novelwriter-project.svg
-cp -v assets/mime/x-novelwriter-project.xml  /usr/share/mime/packages/
-
-update-mime-database /usr/share/mime/
-update-icon-caches /usr/share/icons/hicolor/24x24/apps/
-update-icon-caches /usr/share/icons/hicolor/48x48/apps/
-update-icon-caches /usr/share/icons/hicolor/96x96/apps/
-update-icon-caches /usr/share/icons/hicolor/256x256/apps/
-update-icon-caches /usr/share/icons/hicolor/512x512/apps/
-update-icon-caches /usr/share/icons/hicolor/1024x1024/apps/
-update-icon-caches /usr/share/icons/hicolor/scalable/apps/
-update-icon-caches /usr/share/icons/hicolor/scalable/mimetypes/

assets/installUbuntu.sh

@@ -1,42 +0,0 @@
-#!/bin/bash
-
-cd ..
-
-EXEC=$(pwd)/novelWriter.py
-EXEC=$(echo $EXEC | sed 's_/_\\/_g')
-
-sed "s/%%exec%%/$EXEC/g" assets/novelwriter.desktop > /usr/share/applications/novelwriter.desktop
-
-if [ ! -d /usr/share/icons/hicolor/24x24/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/24x24/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/48x48/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/48x48/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/96x96/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/96x96/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/256x256/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/256x256/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/512x512/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/512x512/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/scalable/apps ]; then
-    mkdir -pv /usr/share/icons/hicolor/scalable/apps
-fi
-if [ ! -d /usr/share/icons/hicolor/scalable/mimetypes ]; then
-    mkdir -pv /usr/share/icons/hicolor/scalable/mimetypes
-fi
-
-cp -v assets/icons/24x24/novelwriter.png     /usr/share/icons/hicolor/24x24/apps/
-cp -v assets/icons/48x48/novelwriter.png     /usr/share/icons/hicolor/48x48/apps/
-cp -v assets/icons/96x96/novelwriter.png     /usr/share/icons/hicolor/96x96/apps/
-cp -v assets/icons/256x256/novelwriter.png   /usr/share/icons/hicolor/256x256/apps/
-cp -v assets/icons/512x512/novelwriter.png   /usr/share/icons/hicolor/512x512/apps/
-cp -v assets/icons/novelwriter.svg           /usr/share/icons/hicolor/scalable/apps/
-cp -v assets/icons/x-novelwriter-project.svg /usr/share/icons/hicolor/scalable/mimetypes/application-x-novelwriter-project.svg
-cp -v assets/mime/x-novelwriter-project.xml  /usr/share/mime/packages/
-
-update-mime-database /usr/share/mime/
-update-icon-caches /usr/share/icons/*

assets/novelwriter.desktop

@@ -1,10 +0,0 @@
-[Desktop Entry]
-Type=Application
-Encoding=UTF-8
-Name=novelWriter
-Comment=Multi-document markdown editor for novels
-Exec=%%exec%% %f
-Icon=novelwriter
-Categories=Qt;Office;WordProcessor;
-Terminal=false
-MimeType=application/x-novelwriter-project

codecov.yml

@@ -3,8 +3,8 @@ codecov:
 
 coverage:
   precision: 2
-  round: up
-  range: "70...100"
+  round: nearest
+  range: "70...95"
 
   status:
     project:
@@ -20,5 +20,3 @@ parsers:
       loop: yes
       method: no
       macro: no
-
-comment: false

docs/source/_static/css/custom.css

@@ -1,23 +0,0 @@
-/*
- * Custom CSS Rules for Sphinx RTD Theme
- */
-
-.kbd {
-    background-color: #eeeeee;
-    border: 1px solid #b4b4b4;
-    border-radius: 3px;
-    color: #333333;
-    display: inline-block;
-    font-size: 0.85em;
-    font-weight: 400;
-    line-height: 1;
-    padding: 2px 4px;
-    margin-left: 1px;
-    margin-right: 1px;
-    white-space: nowrap;
-}
-
-.tight-table td {
-    white-space: normal !important;
-    vertical-align: text-top;
-}

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,146 +1,84 @@
-# -*- coding: utf-8 -*-
-#
-# 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
+"""
 
-# -- Path setup --------------------------------------------------------------
+# -- Imports -----------------------------------------------------------------
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath("."))
-import os, time, sphinx_rtd_theme
+import os
+import time
+import datetime
 
-# -- Project information -----------------------------------------------------
+# -- Project Information -----------------------------------------------------
 
 project = "novelWriter"
-copyright = "2018-2020, Veronica Berglyd Olsen"
+copyright = f"{datetime.date.today().year}"
 author = "Veronica Berglyd Olsen"
 
-# The short X.Y version
-version = "0.12.0"
-# The full version, including alpha/beta/rc tags
-release = "0.12.0"
+initFile = os.path.join(
+    os.path.dirname(__file__), os.pardir, os.pardir,
+    "novelwriter", "__init__.py"
+)
+with open(initFile) as inFile:
+    for aLine in inFile:
+        if aLine.startswith("__version__"):
+            release = aLine.split('"')[1].strip()
+            break
+    else:
+        release = "unknown"
 
+version = release.partition("-")[0]
 
-# -- General configuration ---------------------------------------------------
+# -- General Configuration ---------------------------------------------------
 
 os.environ["TZ"] = "Europe/Oslo"
 time.tzset()
 
-# needs_sphinx = "1.0"
-extensions = [
-    "sphinx_rtd_theme",
-]
+needs_sphinx = "5.0"
+extensions = ["sphinx_design"]
 templates_path = ["_templates"]
 source_suffix = ".rst"
 master_doc = "index"
-today_fmt = "%A, %B %d %Y at %H:%M"
-language = None
+today_fmt = "%A, %d %B %Y at %H:%M"
+language = "en"
 exclude_patterns = []
-pygments_style = None
 
+# -- Options for HTML Output -------------------------------------------------
 
-# -- Options for HTML output -------------------------------------------------
-
-html_theme = "sphinx_rtd_theme"
-html_logo = "images/novelwriter.png"
+html_theme = "sphinx_book_theme"
+html_title = f"Version {release}"
+html_static_path = ["_static"]
+html_css_files = ["custom.css"]
 html_theme_options = {
-    # Toc options
-    "collapse_navigation": True,
-    "sticky_navigation": True,
-    "navigation_depth": 3,
-    "includehidden": True,
-    "titles_only": False,
-    "logo_only": True,
+    "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_static_path = ["_static"]
-html_css_files = [
-    "css/custom.css",
-]
-
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-# The default sidebars (for documents that don"t match any pattern) are
-# defined by theme itself.  Builtin themes are using these templates by
-# default: ``["localtoc.html", "relations.html", "sourcelink.html",
-# "searchbox.html"]``.
-# html_sidebars = {}
-
-
-# -- Options for HTMLHelp output ---------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "novelWriterDoc"
-
-
-# -- Options for LaTeX output ------------------------------------------------
+# -- Options for LaTeX Output ------------------------------------------------
 
 latex_elements = {
-    # The paper size ("letterpaper" or "a4paper").
-    #
-    # "papersize": "letterpaper",
-
-    # The font size ("10pt", "11pt" or "12pt").
-    #
-    # "pointsize": "10pt",
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # "preamble": "",
-
-    # Latex figure (float) alignment
-    #
-    # "figure_align": "htbp",
+    "papersize": "a4paper",
+    "pointsize": "11pt",
+    "preamble": (
+        "\\usepackage[utf8]{inputenc}\n"
+        "\\DeclareUnicodeCharacter{2212}{\\textendash}\n"
+    ),
+    "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, "novelWriter.tex", "novelWriter Documentation",
-    author, "manual"
+    master_doc, "manual.tex", "User Guide", author, "manual"
 )]
-
-
-# -- Options for manual 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/export.rst

@@ -1,153 +0,0 @@
-.. _a_export:
-
-******************
-Exporting Projects
-******************
-
-The novelWriter project can be exported in various formats using the build tool available from
-:guilabel:`Build Novel Project` in the :guilabel:`Tools` menu, or by pressing :kbd:`F5`.
-
-
-.. _a_export_headers:
-
-Header Formatting
-=================
-
-The titles for the five types of titles (the chapter headings come in a numbered and unnumbered
-version) of story structure can be formatted collectively in the export 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 is 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 file with layout :guilabel:`Chapter`. If the file has layout
-   :guilabel:`Unnumbered`, the counter is *not* incremented. The latter is useful for for instance
-   Prologue and Epilogue chapters.
-
-``%chw%``
-   This is like ``%ch%``, but the number is expressed as a word like for instance "One", "Two", etc.
-
-``%chi%``
-   This is also like ``%ch%``, but the number is represented as a lower case Roman number.
-
-``%chI%``
-   This is also like ``%ch%``, but the number is represented as an upper case Roman number.
-
-``%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%``
-   This is like ``%sc%``, but the number is *not* reset to 1 for each chapter. Instead it runs from
-   1 from the beginning of the novel.
-
-``\\``
-   This inserts a line break within the title.
-
-.. note::
-   Header formatting only applies to novel files. Headings in note files will will be left as-is on
-   export. However, heading levels 1 through 4 are converted to the correct heading level in the
-   respective output formats.
-
-**Example**
-
-* The format ``%title%`` just reproduces the title you set in the document file.
-* 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 (and for your sections if you have them), you can leave
-the boxes empty, and an empty paragraph will be inserted between the scenes or sections instead.
-
-Alternatively, if you want a separator between them, like the common ``* * *``, you can also enter
-that in the 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 files are selected for export can also be controlled from the options on the left side of the
-dialog window. The switch for :guilabel:`Include novel files` will select any file that isn't
-classified as a note. The switch for :guilabel:`Include note files` will select any file that *is*
-a note. This is allows for exporting just the novel, just your notes, or both, as you see fit.
-
-In addition, you can select to export the synopsis comments, regular comments, keywords, and even
-exclude the body text itself.
-
-.. 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 files from your exports, like draft files or files you want to take
-out of your manuscript, but don't want to delete, you can un-check the :guilabel:`Include when
-building project` option for each file in the project tree. An included file has a checkmark after
-the status icon in the :guilabel:`Flags` column. The :guilabel:`Build Novel Project` tool has a
-switch to ignore this flag if you need to collectively override these settings.
-
-
-.. _a_export_formats:
-
-Export Formats
-==============
-
-Currently, six formats are supported for exporting.
-
-OpenDocument Format
-   This produces an open document ``.odt`` file. The document produced has very little formatting,
-   and may require further editing afterwards. For a better formatted office document, you may get a
-   better result with exporting to HTML and the import that HTML document into your office word
-   processor. They are generally very good at importing HTML files.
-
-PDF Format
-   The PDF export is just a shortcut for print to file. For a better PDF result, you may instead
-   want to export HTML, and use a word processor to convert the HTML document to PDF.
-
-novelWriter HTML
-   The HTML export format writes a single ``.htm`` file with minimal style formatting. The exported
-   HTML file is suitable for further processing by document conversion tools like Pandoc, for
-   importing in word processors, or for printing from browser. It is generally the best formatted
-   export option and supports all features of novelWriter since it is entirely geenrated by the
-   application and doesn't depend on Qt library features.
-
-novelWriter Markdown
-   This is simply a concatenation of the files selected by the filters. The files in the project are
-   stacked together in the order they appear in the tree view, 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 Markdown
-   If you have Qt 5.14 or higher, the option to export to plain markdown is available. This feature
-   uses Qt's own markdown export feature.
-
-Plain Text
-   The plain text export format writes a simple ``.txt`` file without any formatting at all.
-
-
-.. _a_export_options:
-
-Additional Export Options
-=========================
-
-In addition to the above document formats, the novelWriter HTML and Markdown formats can also be
-wrapped in a JSON file. The files will have a meta data entry and a body entry. For HTML, also the
-accompanying css styles are exported.
-
-The text body is saved in a two-level list. The outer list contains one entry per exported file, in
-the order they appear in the project tree. Each file is then split up into a list as well, with one
-entry per paragraph in the document.
-
-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/index.rst

@@ -1,87 +1,89 @@
-#####################
-novelWriter |release|
-#####################
+######################
+novelWriter User Guide
+######################
 
-.. image:: https://travis-ci.com/vkbo/novelWriter.svg?branch=master
-   :target: https://travis-ci.com/vkbo/novelWriter
-   :alt: Build Status
+| **Release Version:** |release|
+| **Updated:** |today|
 
-.. image:: https://codecov.io/gh/vkbo/novelWriter/branch/master/graph/badge.svg
-   :target: https://codecov.io/gh/vkbo/novelWriter
-   :alt: Code Coverage
+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
+editor that allows for easy organisation of text and notes, using human readable text files as
+storage for robustness.
 
-.. image:: https://readthedocs.org/projects/novelwriter/badge/?version=latest
-   :target: https://novelwriter.readthedocs.io/en/latest/?badge=latest
-   :alt: Documentation
+.. figure:: images/screenshot_multi.png
+   :class: dark-light
+   :align: center
+   :width: 500
 
-.. image:: https://img.shields.io/github/v/release/vkbo/novelwriter
-   :target: https://github.com/vkbo/novelWriter/releases
-   :alt: GitHub Release
-
-.. image:: https://img.shields.io/pypi/v/novelwriter
-   :target: https://pypi.org/project/novelWriter/
-   :alt: PyPI
-
-.. image:: https://img.shields.io/pypi/pyversions/novelwriter
-   :target: https://pypi.org/project/novelWriter/
-   :alt: Python Version
-
-**Last Updated:** |today|
-
-novelWriter is a markdown-like text editor designed for writing novels and larger projects of many
-smaller plain text documents. It uses its own flavour of markdown that supports a meta data syntax
-for comments, synopsis and cross-referencing between files. The idea is to have a simple text editor
-which allows for easy organisation of text files and notes, built on a plain text file project
-repository for robustness.
-
-The plain text storage is suitable for version control software, and also well suited for file
-synchronisation tools. The core project structure is stored in a project XML file. Other meta data
-is primarily saved as JSON files.
+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 saved as JSON files.
+See the :ref:`a_breakdown_storage` section 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 already, and users have tested it on other
-platforms too. Since novelWriter is still under development, it is easier to run it if you are
-already familiar with how to run Python applications on your platform.
+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
+with pip. See :ref:`a_started` for more details.
 
 **Useful Links**
 
 * Website: https://novelwriter.io
-* Documentation: https://novelwriter.readthedocs.io
+* Documentation: https://docs.novelwriter.io
+* Internationalisation: https://crowdin.com/project/novelwriter
 * Source Code: https://github.com/vkbo/novelWriter
 * Source Releases: https://github.com/vkbo/novelWriter/releases
 * Issue Tracker: https://github.com/vkbo/novelWriter/issues
+* Feature Discussions: https://github.com/vkbo/novelWriter/discussions
 * PyPi Project: https://pypi.org/project/novelWriter
-
+* Social Media: https://fosstodon.org/@novelwriter
 
 .. toctree::
-   :maxdepth: 2
-   :caption: First Steps
-
-   introduction
-   started
-   interface
+   :hidden:
 
+   Main Page <self>
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Writing Novels
-
-   projects
-   structure
-   notes
-   export
+   :maxdepth: 1
+   :caption: Introduction
+   :hidden:
 
+   int_introduction
+   int_overview
+   int_started
+   int_howto
+   int_customise
+   int_glossary
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Under the Hood
+   :maxdepth: 1
+   :caption: Using novelWriter
+   :hidden:
 
-   technical
+   usage_breakdown
+   usage_project
+   usage_writing
+   usage_format
+   usage_shortcuts
+   usage_typography
+   usage_projectformat
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Organising Your Project
+   :hidden:
 
-Indices and Tables
-==================
+   project_overview
+   project_structure
+   project_references
+   project_manuscript
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. toctree::
+   :maxdepth: 1
+   :caption: Additional Topics
+   :hidden:
+
+   tech_locations
+   tech_storage
+   tech_source
+   tech_tests

docs/source/int_customise.rst

@@ -0,0 +1,176 @@
+.. _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 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 or aspell 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. 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.
+
+.. 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, altough 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 :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, 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 :guilabel:`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.
+
+
+Gustom 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]
+   statusnone      = 100, 100, 100
+   statussaved     = 100, 100, 100
+   statusunsaved   = 100, 100, 100
+
+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  to 255.
+Omitted values are not loaded and will use default values.
+
+
+Custom Syntax Theme
+-------------------
+
+A syntax theme ``.conf`` file consists of the follwing 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
+   straightquotes =   0,   0,   0
+   doublequotes   =   0,   0,   0
+   singlequotes   =   0,   0,   0
+   hidden         =   0,   0,   0
+   shortcode      =   0,   0,   0
+   keyword        =   0,   0,   0
+   value          =   0,   0,   0
+   spellcheckline =   0,   0,   0
+   errorline      =   0,   0,   0
+   replacetag     =   0,   0,   0
+   modifier       =   0,   0,   0
+
+In the Main section, you must define at least the ``name`` setting. The Syntax colour values are
+RGB numbers of the format ``r, g, b`` where each is an integer from  to 255. Omitted values default
+to black, except ``background`` which defaults to white,
+
+.. versionadded:: 2.2
+   The `shortcode` syntax colour entry was added, so you need to update your custom themes if you
+   made any before version 2.2.

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 header 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,83 @@
+.. _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, and 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:: Merge Multiple Documents Into One
+   :animate: fade-in-slide-down
+
+   If you need to merge a set 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 files 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 also rearrange them here of you wish. See :ref:`a_ui_tree_split_merge` for more details.
+
+
+Layout Tricks
+=============
+
+.. dropdown:: Create a Simple 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 :guilabel:`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.
+
+
+Organising Your Text
+====================
+
+.. dropdown:: 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 (added in novelWriter 2.0).
+
+.. dropdown:: Distinguishing 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 the scene heading for hard scene breaks and section headings
+   for soft scene breaks. the :guilabel:`Build Manuscript` tool will let you add separate
+   formatting for the two when you generate your manuscript. You can for instance add the common
+   "``* * *``" for hard breaks and select to hide section breaks, which will just insert an empty
+   paragraph in their place. See :ref:`a_manuscript_settings` for more details.
+
+
+Other Tools
+===========
+
+.. dropdown:: Convert Project to/from 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

@@ -0,0 +1,91 @@
+.. _a_intro:
+
+************
+Key Features
+************
+
+.. _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. 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 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.
+
+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 between chapters.
+
+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`. These 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 headers up into multiple documents, or
+merge multiple documents into single documents. This makes it easier to use variations of the
+Snowflake_ method for writing. You can focus on writing larger structure-focused documents, like
+one per act for instance, and later effortlessly split these up into scenes by their headers.
+
+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 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, 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 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. You can also start out with a few documents and then later split them
+   into multiple documents based on their headers.
+
+**Multi-novel project support**
+   As of novelWriter 2.0, you can have multiple Novel type root folders in a project. 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 individually.
+
+**Keep track of your plot elements**
+   All notes in your project can be assigned a :term:`tag` that you can :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 ot.
+
+**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 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 :guilabel:`Novel View` as an
+   alternative view to the project tree.
+
+**Building 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, you can use the :guilabel:`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, 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.
+
+
+.. _a_intro_screenshots:
+
+Screenshots
+===========
+
+.. figure:: images/screenshot_default.png
+   :class: dark-light
+
+   novelWriter with default theme
+
+.. figure:: images/screenshot_dark.png
+   :class: dark-light
+
+   novelWriter with dark theme

docs/source/int_overview.rst

@@ -0,0 +1,92 @@
+.. _a_overview:
+
+********
+Overview
+********
+
+.. only:: html
+
+   .. image:: images/python_powered.png
+      :align: right
+      :width: 220
+
+novelWriter is built as a cross-platform application using `Python 3 <https://www.python.org/>`_ as
+the programming language, and `Qt 5 <https://www.qt.io/>`_ for the user interface.
+
+novelWriter is built for Linux first, and this is where it works best. However, it also runs fine
+on Windows and MacOS due to the cross-platform framework it's built on. The author of the
+application doesn't own a Mac, so on-going Mac support is dependent on user feedback and user
+contributions.
+
+Spell checking in novelWriter is provided by a third party library called
+`Enchant <https://abiword.github.io/enchant/>`_. Please see the section on :ref:`a_custom_dict` for
+how to install spell checking languages.
+
+For install instructions, see :ref:`a_started`.
+
+
+Using novelWriter
+=================
+
+In order to use novelWriter effectively, you need to know the basics of how it works. The following
+chapters will explain the main principles. It starts with the basics, and gets more detailed as you
+read on.
+
+:ref:`a_breakdown` – Essential Information
+   This chapter explains the basics of how the application works and what it can and cannot do.
+
+: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 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 by how you
+   use headings. Tags and references are implemented by special keywords.
+
+:ref:`a_kb` – Optional / Lookup
+   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 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
+   intended use is explained here.
+
+:ref:`a_prjfmt` – Optional
+   This chapter 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
+   chapter.
+
+
+Organising Your Projects
+========================
+
+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 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 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_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_manuscript` - Recommended Reading
+   This chapter explains how the :guilabel:`Manuscript Build` tool works, how you can control the
+   way chapter titles are formatted, and how scene and section breaks are handled.

docs/source/int_started.rst

@@ -0,0 +1,178 @@
+.. _a_started:
+
+***************
+Getting Started
+***************
+
+.. _Enchant: https://abiword.github.io/enchant/
+.. _GitHub: https://github.com/vkbo/novelWriter
+.. _main website: https://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/
+.. _Releases: https://github.com/vkbo/novelWriter/releases
+.. _AppImage: https://appimage.org/
+
+Package installers for novelWriter are available for all major platforms, including Linux, Windows
+and MacOS. See below for 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.
+
+
+.. _a_started_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_.
+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 as having
+multiple installations has been known to cause problems.
+
+.. note::
+   The novelWriter installer is not signed because Microsoft 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 commercial software signing certificates. You will therefore
+   see an additional warning about this when you download the installer.
+
+
+.. _a_started_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.
+
+If you prefer, you can also add the novelWriter repository on Launchpad to your package manager.
+
+
+Ubuntu
+------
+
+You can add the Ubuntu PPA_ and install novelWriter with the following commands.
+
+.. code-block:: bash
+
+   sudo add-apt-repository ppa:vkbo/novelwriter
+   sudo apt update
+   sudo apt install novelwriter
+
+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, 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 jammy main" | sudo tee /etc/apt/sources.list.d/novelwriter.list
+
+Then run the update and install commands as for Ubuntu:
+
+.. code-block:: bash
+
+   sudo apt update
+   sudo apt install novelwriter
+
+.. note::
+   You may need to use the Ubuntu 20.04 (focal) packages for Debian 11 or earlier. The newer Ubuntu
+   packages use a different compression algorithm that may not be supported.
+
+.. 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:
+
+   .. code-block:: bash
+
+      sudo mkdir /root/.gnupg/
+
+
+AppImage Releases
+-----------------
+
+For other Linux distros than the ones mentioned above, the primary option is AppImage_. These are
+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.
+
+.. note::
+   novelWriter generally don'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_macos:
+
+Installing on MacOS
+===================
+
+You can install novelWriter with both its Python and library dependencies embedded using the DMG
+application image file from the `main website`_, or from the Releases_ page on GitHub_. Installing
+it should be straightforward.
+
+* 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.
+
+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::
+   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 commercial software signing certificates.
+
+
+.. _a_started_pip:
+
+Installing from PyPi
+====================
+
+novelWriter is also available on the Python Package Index, or PyPi_. This install method works on
+all supported operating systems.
+
+To install from PyPi you must first have the ``python`` and ``pip`` commands available on your
+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:
+
+.. code-block:: bash
+
+   pip install novelwriter
+
+To upgrade an existing installation, use:
+
+.. code-block:: bash
+
+   pip install --upgrade novelwriter
+
+When installing via pip, novelWriter can be launched from command line with:
+
+.. code-block:: bash
+
+   novelwriter
+
+Make sure the install location for pip is in your PATH variable. This is not always the case by
+default, and then you may get a "Not Found" error when running the ``novelwriter`` command.

docs/source/interface.rst

@@ -1,397 +0,0 @@
-.. _a_ui:
-
-***************
-User Interface
-***************
-
-The user interface is kept as simple as possible to avoid distractions when writing. This page lists
-all the main GUI elements, and explains what they do.
-
-.. _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. It has four columns:
-
-:guilabel:`Label`
-   The first column shows the item icon and its label. The labels can be edited from the menu, or by
-   pressing :kbd:`F2` or :kbd:`Ctrl`:kbd:`E`. The label is not the same as the title you set inside
-   the document, but it will appear in the header above the document text itself.
-
-:guilabel:`Words`
-   The second column shows the word count of the file, or the sum of words in the child items if it
-   is a folder. If the counts seem incorrect, they can be updated by rebuilding the project index
-   from the :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
-
-:guilabel:`Inc`
-   The third column indicates whether the file is included in the final project build or not. You
-   may want to filter out files that you no longer want to keep in the final manuscript, but want to
-   keep in the project for reference.
-
-:guilabel:`Flags`
-   The fourth column shows various meta data flags for the item. The first is an icon indicating the
-   importance or status of the file. These are colour coded status levels that you control and
-   define yourself. They can be changed in :guilabel:`Project Settings` from the :guilabel:`Project`
-   menu. The first character after the icon indicates the class of the item, that is ``N`` for
-   **Novel**, ``C`` for **Character**, etc (see :ref:`a_struct_tags`. The second character indicates
-   the file layout type (see :ref:`a_proj_roots`).
-
-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_edit:
-
-Editing and Viewing Documents
-=============================
-
-To edit a document, double-click the file in the project tree, or press the :kbd:`Return` key while
-having it selected. This will open the file in the document editor. The editor uses a simplified
-markdown format. The format is described in the :ref:`a_ui_md` section below. The editor has a
-maximise button (activates :guilabel:`Focus Mode`) and a close button in the top-right corner.
-
-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. The
-document viewed does not have to be the same document 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 little 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 file can be shown. This can be set
-in the :guilabel:`Preferences` dialog from the :guilabel:`Tools` menu. Clicking on the document
-title bar will select and reveal the file in the project tree, making it easier to find the project
-location of the file in a large project.
-
-Any reference to a tag in the editor can be opened in the viewer by moving the cursor to the label
-and pressing :kbd:`Ctrl`:kbd:`Return`. 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.
-
-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 it, 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.
-
-.. note::
-   The :guilabel:`References` panel relies on an up-to-date index of the project. 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_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`.
-
-.. 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_ui_shortcuts_ins`.
-
-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, but this feature isn't always
-accurate.
-
-.. tip::
-   If the editor 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_md:
-
-Markdown Format
-===============
-
-The document editor uses a simplified markdown format. That is, it supports basic formatting like
-emphasis (italic), strong importance (bold) and strikethrough text, as well as four levels of
-headings.
-
-Some non-standard markdown features have been added. For instance, novelWriter allows for comments,
-a synopsis tag, and a set of keyword and value sets used for tags and references.
-
-
-.. _a_ui_md_head:
-
-Headings
---------
-
-Four levels of headings are allowed. For files of type "Note", they are free to be used as you see
-fit, but for all other file layouts used for the novel text itself, they indicate the structural
-level of the novel. See :ref:`a_struct_heads` for more details.
-
-``# Title``
-   Heading level one. If the file is a novel file, the header level indicates the start of a new
-   partition. This heading level can also be used for the title page novel title.
-
-``## Title``
-   Heading level two. If the file is a novel file, the header level indicates the start of a new
-   chapter.
-
-``### Title``
-   Heading level three. If the file is a novel file, the header level indicates the start of a new
-   scene.
-
-``#### Title``
-   Heading level four. If the file is a novel file, the header level indicates the start of a new
-   section.
-
-.. note::
-   The space after the ``#`` characters is mandatory. The syntaxhighlighter will change colour and
-   font size when the heading is correctly formatted.
-
-
-.. _a_ui_md_emph:
-
-Text Emphasis
--------------
-
-A minimal set of text emphasis styles are supported.
-
-``_text_``
-   The text is rendered as emphasised text (italicised).
-
-``**text**``
-   The text is rendered as strongly important text (bold).
-
-``~~text~~``
-   Strikethrough text.
-
-In markdown guides it is often recommended to differentiate between strong importance and emphasis
-by using ``**`` for strong and ``_`` for emphasis, although markdown generally supports also ``__``
-for strong and ``*`` fdr emphasis. However, since the differentiation makes the highlighting and
-conversion significantly simpler and faster, in novelWriter this is a rule, not just a
-recommendation. The following is therefore the only supported formatting syntax:
-
-There are also some additional rules:
-
-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.
-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.
-
-
-.. _a_ui_md_comm:
-
-Comments and Synopsis
----------------------
-
-In addition to these standard markdown features, novelWriter also allows for comments in the text
-files. The text of the comment is ignored by the word counter and not exported or, optionally,
-hidden when viewing the document. If the first word of a comment is ``Synopsis:`` (with the colon),
-the comment is treated specially, and will show up in the :ref:`a_ui_outline` in a dedicated column.
-
-``% text...``
-   A comment. The text is not exported by default (this can be overridden), seen in the Viewer, or
-   counted towards word counts.
-
-``% Synopsis: text...``
-   A synopsis comment. It is generally treated in the same way as regular comments, except that it
-   is captured by the indexing algorithm and displayed in the :ref:`a_ui_outline`. It can also be
-   filtered separately when exporting the project to for instance generate an outline document of
-   the whole project.
-
-
-.. _a_ui_md_tags:
-
-Tags and References
--------------------
-
-The document editor supports a minimal set of keywords used for setting tags, and making references
-between files. The tags and references can be set once per section defined by a heading. Using them
-multiple times under the same heading will just override the previous setting.
-
-``@keyword: value``
-   A keyword argument followed by a value, or a comma separated list of values.
-
-The available tag and reference keywords are listed in the :ref:`a_struct_tags` section.
-
-
-.. _a_ui_md_add:
-
-Additional Markdown and Non-Standard Features
----------------------------------------------
-
-The editor and viewer also supports markdown standard hard line breaks, and preserves non-breaking
-spaces if running with Qt 5.9 or higher. For older versions, the non-breaking spaces are lost when
-the file is saved. This is unfortunately hard-coded in the Qt text editor.
-
-* A hard line break is achieved by leaving two or more spaces at the end of the line. Alternatively,
-  the user can press :kbd:`Ctrl`:kbd:`K`, :kbd:`Return` to insert this.
-* A non-breaking space is 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`.
-
-These are all insert features, and the :guilabel:`Insert` menu has more. They are also listed
-in :ref:`a_ui_shortcuts_ins`.
-
-Both hard line breaks and non-breaking spaces are highlighted by the syntax highlighter as an
-alternate coloured background, depending on the selected theme.
-
-
-.. _a_ui_outline:
-
-Project Outline View
-====================
-
-The project's Outline view is available as the second tab on the right hand side of the main window
-labelled :guilabel:`Outline`. 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, not the files.
-
-The document file 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 file in the
-editor.
-
-.. note::
-   Since the internal structure of the novel does not depend on the file structure of the project
-   tree, these will not necessarily look the same, depending how you chose to organise your files.
-   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 by right clicking
-the header and selecting the columns you want to show. The order of the columns can also be
-rearranged by dragging them to a different position.
-
-.. 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 content changes, you can always rebuild it manually by
-pressing :kbd:`F9` if something isn't right.
-
-The outline view itself can be regenerated by pressing :kbd:`F10`. You can also enable automatic
-updating in the :guilabel:`Tools` menu, which will trigger an update whenever the index is updated
-and the :guilabel:`Outline` tab is active. You may want to disable this feature if your project is
-very large,
-
-
-.. _a_ui_outline_synopsis:
-
-Synopsis Column
----------------
-
-The :guilabel:`Synopsis` column of the outline view takes its information from a specially formatted
-comment. See :ref:`a_ui_md_comm`. In order to flag a comment as a synopsis, add the word
-``Synopsis:`` as the first word of the comment. The ``:`` is required, and 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.
-
-.. note::
-   Only one comment can be flagged as a synopsis comment for each heading. If multiple comments are
-   flagged as a synopsis comment, the last one will be used.
-
-
-.. _a_ui_shortcuts:
-
-Keyboard Shortcuts
-==================
-
-Most features are available as keyboard shortcuts. These are as follows:
-
-.. csv-table:: Keyboard Shortcuts
-   :header: "Shortcut", "Description"
-   :widths: 30, 70
-   :class: "tight-table"
-
-   ":kbd:`Alt`:kbd:`1`",                 "Switch focus to the project tree."
-   ":kbd:`Alt`:kbd:`2`",                 "Switch focus to document editor."
-   ":kbd:`Alt`:kbd:`3`",                 "Switch focus to document viewer."
-   ":kbd:`Ctrl`:kbd:`.`",                "Open menu to correct word under cursor."
-   ":kbd:`Ctrl`:kbd:`,`",                "Open the :guilabel:`Preferences` dialog."
-   ":kbd:`Ctrl`:kbd:`/`",                "Change block format to comment."
-   ":kbd:`Ctrl`:kbd:`-`",                "Strikethrough selected text, or word under cursor."
-   ":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:`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`",                "Wrap selected text, or word under cursor, in double quotes."
-   ":kbd:`Ctrl`:kbd:`E`",                "If in the project tree, edit a document or folder settings. (Same as :kbd:`F2`)"
-   ":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. (Same as :kbd:`F3`)"
-   ":kbd:`Ctrl`:kbd:`H`",                "Open the search and replace bar 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:`N`",                "Create new document."
-   ":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 the editor has focus, 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:`F10`",              "Toggle automatic updating of project outline."
-   ":kbd:`Ctrl`:kbd:`Del`",              "If in the project tree, move a document to trash, or delete a folder."
-   ":kbd:`Ctrl`:kbd:`Enter`",            "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:`D`",    "Wrap selected text, or word under cursor, in single quotes."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`G`",    "Find previous occurrence of search word in current document. (Same as :kbd:`Shift`:kbd:`F3`)"
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`I`",    "Import text to the current document from a text file."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`N`",    "Create new folder."
-   ":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:`Up`",   "Move item one step up in the project tree."
-   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`Down`", "Move item one step down in the project tree."
-   ":kbd:`F1`",                          "Open the documentation. This will either open the Qt Assistant, if available, or send you to the documentation website."
-   ":kbd:`F2`",                          "If in the project tree, edit a document or folder settings. (Same as :kbd:`Ctrl`:kbd:`E`)"
-   ":kbd:`F3`",                          "Find next occurrence of search word in current document. (Same as :kbd:`Ctrl`:kbd:`G`)"
-   ":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`",                          "Activate :guilabel:`Focus Mode`, hiding the project tree and document viewer."
-   ":kbd:`F9`",                          "Re-build the project index."
-   ":kbd:`F10`",                         "Re-build the project outline."
-   ":kbd:`F11`",                         "Activate full screen mode."
-   ":kbd:`Shift`:kbd:`F1`",              "Open the online documentation in the system default browser."
-   ":kbd:`Shift`:kbd:`F3`",              "Find previous occurrence of search word in current document. (Same as :kbd:`Ctrl`:kbd:`Shift`:kbd:`G`)"
-   ":kbd:`Return`",                      "If in the project tree, open a document for editing."
-
-.. note::
-   On macOS, replace :kbd:`Ctrl` with :kbd:`Cmd`.
-
-
-.. _a_ui_shortcuts_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-K`, followed by a key or
-combination for the inserted character or punctuation.
-
-.. csv-table:: Keyboard Shortcuts
-   :header: "Shortcut", "Description"
-   :widths: 40, 60
-   :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:`.`",                 "Insert ellipsis."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`1`",                 "Insert left single quote."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`2`",                 "Insert right single quote."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`3`",                 "Insert left double quote."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`4`",                 "Insert right double quote."
-   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Return`",            "Insert a hard line break."
-   ":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."

docs/source/introduction.rst

@@ -1,122 +0,0 @@
-.. _a_intro:
-
-************
-Introduction
-************
-
-novelWriter is a simple, multi-document plain text editor using a modified markdown syntax to apply
-simple formatting. It is designed for writing novels, and allows for the component documents to be
-ordered freely to create the desired structure of the novel. More details about how projects are
-structured is covered on the :ref:`a_struct` page.
-
-In addition, the project can contain notes on the various plot elements, characters, locations, etc,
-that make up the story. These notes are organised in a set of category-specific top-level folders,
-and each entry can be tagged and cross-referenced from within the novel files and other notes. These
-tags make it possible to inter-link documents, and generate an overview of the entire novel project
-and how the various files and plot elements are interconnected. This is covered on the :ref:`a_proj`
-and :ref:`a_notes` pages.
-
-These additional features are not standard in markdown, but are available through special meta
-keywords. Syntax highlighting is provided to make it easier to verify that the markdown tags are
-used correctly. The syntax is covered on the :ref:`a_ui` page.
-
-
-.. _a_intro_design:
-
-Design Philosophy
-=================
-
-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. 
-
-.. note::
-   novelWriter is not intended to be a full office type word processor. It doesn't support images,
-   links, tables, and other complex structure and objects often needed for such document. Formatting
-   is limited to headers, and bold, italicised and strikethrough text.
-
-The main window does not have a toolbar like most other applications do. This reduces clutter, and
-since the documents are formatted with markdown tags, is more or less redundant. However, all
-formatting features supported are available through convenient keyboard shortcuts. They are also
-available in the main menu. A full list of shortcuts can be found in the :ref:`a_ui_shortcuts`
-section.
-
-In addition, novelWriter offers a :guilabel:`Focus Mode` where all the user interface elements other
-than the document editor itself are hidden away.
-
-The colour scheme of the user interface defaults to that of the host operating system. In addition,
-a dark theme is provided, and can be enabled in :guilabel:`Preferences` from the :guilabel:`Tools`
-menu. A number of syntax highlighting themes are also available in :guilabel:`Preferences`. A set of
-icon themes in colour and greyscale are also offered. The icons are based on the Typicon_ icon set
-designed by Stephen Hutchings.
-
-The main window is split in two, or optionally three, panels. The left-most contains the project
-tree and all the files in your project. The second panel is the document editor, and the optional
-third panel is a document viewer which can view any document in your project.
-
-A second tab is also available on the main window. This is the :guilabel:`Outline` tab where the
-entire novel structure can be displayed, with all the tags and references listed. Depending on how
-you structure your novel project files, this outline can be quite different than your project tree.
-Your project tree lists files, your Outline tree lists the structure of the novel itself.
-
-.. _Typicon: https://github.com/stephenhutchings/typicons.font
-
-
-.. _a_intro_project:
-
-Project Layout
-==============
-
-You are free to structure your project files as you wish in subfolders, and split the text between
-files in whatever way suits you. All that matters to novelWriter is the linear order the files
-appear at in the project tree (top to bottom). The chapters, scenes and sections of the novel are
-determined by the headings within those files.
-
-The four heading levels (**H1** to **H4**) are treated as follows:
-
-* **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.
-
-This header level structure is only taken into account for novel files. For the files designated as
-project notes, the header levels imply no structural meaning, and the user is free to do whatever
-they want. See the :ref:`a_struct` page for more details.
-
-
-.. _a_intro_export:
-
-Project Export
-==============
-
-The project can at any time be exported to a range of different formats. Natively, novelWriter
-supports export to plain text file, HTML document, novelWriter flavoured markdown, standard
-markdown (requires Qt 5.14), and to a basic Open Document.
-
-In addition, printing and printing to PDF is also possible. The best supported export format is
-HTML, which can be imported or converted by a number of other tools like Pandoc, or simply imported
-into Libre Office Writer and similar word processors.
-
-It is also possible to 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.
-
-A number of filter options can be applied to the produced document, allowing you to export a draft
-manuscript, a reference document of notes, an outline based on chapter and scene titles with a
-synopsis each, and so on. See the :ref:`a_export` page for more details on export features and
-formats.
-
-
-.. _a_intro_screenshots:
-
-Screenshot
-==========
-
-**novelWriter with default system theme:**
-
-.. image:: images/screenshot_default.png
-   :width: 800
-
-**novelWriter with dark theme:**
-
-.. image:: images/screenshot_dark.png
-   :width: 800

docs/source/notes.rst

@@ -1,44 +0,0 @@
-.. _a_notes:
-
-************************
-Supporting Files (Notes)
-************************
-
-novelWriter doesn't have a database and compicated forms to fill in all 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. The relation between all these additional elements
-is extracted from these files by the project indexer based on the tags and references you set.
-
-These files are not required, but making at least minimal files for each such plot element, and add
-a tag to them, makes it possible to use the :guilabel:`Outline` feature to see how each element
-intersects with each section of the novel itself, and add clickable cross-references between
-documents in the editor and viewer.
-
-
-.. _a_notes_tags:
-
-Tags in Notes
-=============
-
-Each new heading in a note file can have a tag associated with it. The format of a tag is
-``@tag: tagname``, where tagname is a unique identifier. Tags can then be referenced in the novel
-files, or cross-referenced in other note files, and will show up in the outline view and in the
-back-reference panel when a document is being viewed.
-
-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 files that the application uses. The rest of the file content is
-there for the writer to use in whatever way they wish. Of course, the content of the files can be
-exported if you want to compile a single document of all your notes, or include them in an outline.
-
-A note file can also reference other note files in the same way novel files do. When the note file
-is opened in the view panel, these become clickable links, making it easier to follow connections in
-the plot. Note files 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.
-
-.. tip::
-   If you cross-reference between notes as well, and export your project as an HTML file using the
-   export tool, the cross-references become clickable in the exported document.

docs/source/project_manuscript.rst

@@ -0,0 +1,185 @@
+.. _a_manuscript:
+
+***********************
+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:`Manuscript Build` tool.
+You can activate it from the sidebar, the :guilabel:`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 has much the same
+   functionality.
+
+
+.. _a_manuscript_main:
+
+The Manuscript Build Tool
+=========================
+
+.. figure:: images/fig_manuscript_build.png
+
+   The :guilabel:`Manuscript Build` tool main window.
+
+The main window of the :guilabel:`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.
+
+
+.. _a_manuscript_settings:
+
+Build Settings
+==============
+
+Each build definition can be edited by opening it in the :guilabel:`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 :guilabel:`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 :guilabel:`Manuscript Build` window.
+   When you're happy with the result, you can close the settings.
+
+
+Document Selection
+------------------
+
+.. figure:: images/fig_build_settings_selections.png
+
+   The :guilabel:`Selections` page of the :guilabel:`Manuscript Build Settings` dialog.
+
+The :guilabel:`Selections` page of the :guilabel:`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.
+
+
+Formatting Headings
+-------------------
+
+.. figure:: images/fig_build_settings_headings.png
+
+   The :guilabel:`Headings` page of the :guilabel:`Manuscript Build Settings` dialog.
+
+The :guilabel:`Headings` page of the :guilabel:`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 like shown int he 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 :guilabel:`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.
+
+
+Output Settings
+---------------
+
+The :guilabel:`Content`, :guilabel:`Format` and :guilabel:`Output` pages of the
+:guilabel:`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
+
+   The :guilabel:`Manuscript Build` dialog used for writing the actual manuscript documents.
+
+When you press the :guilabel:`Build` button on the :guilabel:`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.
+
+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 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.
+
+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 strikethrough text, which is not supported by
+   the Standard flavour.
+
+
+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:
+
+Print and PDF
+=============
+
+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 :guilabel:`Print Preview` dialog.

docs/source/project_overview.rst

@@ -0,0 +1,342 @@
+.. _a_proj:
+
+**************
+Novel 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.
+
+A novelWriter project requires a dedicated folder for storing its files on the local file system.
+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.
+
+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.
+
+
+.. _a_proj_roots:
+
+Project Roots
+=============
+
+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 :term:`novel documents` go into a root folder of type :guilabel:`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 :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 :guilabel:`Novel` folder, no restrictions are applied by the
+application on what you put in them. You can use them however you want.
+
+The root folder system is closesly connected to how the Tags and References system works. For more
+details, see the :ref:`a_references` chapter.
+
+:guilabel:`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 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 :guilabel:`Outline View`.
+   Tags in this folder can be references using the ``@plot`` keyword.
+
+:guilabel:`Characters`
+   Character notes go in this root folder type. These are especially important if you want to use
+   the :guilabel:`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. 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:`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.
+
+:guilabel:`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 objects that change hands often, can be tracked
+   here. Tags in this type of folder can be references using the ``@object`` keyword.
+
+:guilabel:`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 type of folder can be references using the
+   ``@entity`` keyword.
+
+:guilabel:`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_references_references`.
+
+.. note::
+   You can rename root folders to whatever you want. However, this doesn't change the reference
+   keyword or what they do.
+
+.. versionadded:: 2.0
+   As of version 2.0, you can make multiple root folders of each kind to split up your project.
+
+
+.. _a_proj_roots_del:
+
+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 :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+Shift+Del`. Root folders can only be deleted when they are empty.
+
+
+.. _a_proj_roots_out:
+
+Archived Documents
+------------------
+
+If you don't want to delete a document, or put it in the :guilabel:`Trash` folder where it may be
+deleted accidentally, but still want it out of your main project tree, you can create an
+:guilabel:`Archive` root folder and move it there.
+
+You can drag any document to this folder and preserve its settings. The document will always be
+excluded from the :guilabel:`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_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 folder that
+aren't tracked in the core project file. These files, when discovered, are recovered and added back
+into the project.
+
+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 :guilabel:`Novel` root folder. Finally, if the :guilabel:`Novel`
+folder is missing, 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 lost documents caused by file conflicts when novelWriter projects are synchronised via
+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 given 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.
+
+
+.. _a_proj_roots_dirs:
+
+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 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 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.
+
+.. versionadded:: 2.0
+   As of version 2.0 it is 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_files:
+
+Project Documents
+=================
+
+New documents can be created from the toolbar in the :guilabel:`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.
+
+You can always rename an item by selecting :guilabel:`Rename Item` from the :guilabel:`Project`
+menu, or by pressing :kbd:`F2`.
+
+Other settings for project items are available from the context menu that you can activate by
+right-clicking on an item in the tree. The :guilabel:`Transform` submenu includes options for
+converting, splitting, or merging items. See :ref:`a_ui_tree_split_merge` for more details on the
+latter two.
+
+
+.. _a_proj_files_counts:
+
+Word Counts
+-----------
+
+A character, word and paragraph count is maintained for each document, as well as for each section
+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 :guilabel:`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 :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 :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
+
+
+.. _a_proj_settings:
+
+Project Settings
+================
+
+The :guilabel:`Project Settings` can be accessed from the :guilabel:`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 :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 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 :guilabel:`Novel Title` and :guilabel:`Authors` settings are used when building the manuscript,
+for some formats.
+
+If your project is in a different language than your main spell checking language is set to, you
+can override the default setting here. You can also override the automatic backup setting. The
+project language can also be changed from the :guilabel:`Tools` menu.
+
+
+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.
+
+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.
+
+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.
+
+
+Auto-Replace Tab
+----------------
+
+A set of automatically replaced keywords can be added in this tab. The keywords in the left column
+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 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.
+
+.. note::
+   A keyword cannot contain spaces. The angle brackets are added by default, and when used in the
+   text are a part of the keyword to be replaced. This is to ensure that parts of the text aren't
+   unintentionally replaced by the content of the list.
+
+
+.. _a_proj_backup:
+
+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`.
+
+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`.
+
+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`.
+
+.. 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 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:
+
+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. For more details
+about the log file, see :ref:`a_storage`.
+
+A tool to view the content of the log 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.
+
+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 or Excel.
+
+.. 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 :guilabel:`Preferences`.

docs/source/project_references.rst

@@ -0,0 +1,178 @@
+.. _a_references:
+
+*******************
+Tags and References
+*******************
+
+In novelWriter there are no forms or tables to fill in to define the characters, locations and
+other elements of your story. Instead, you can mark your :term:`project notes` as representing
+these story elements by creating a :term:`tag`. Whenever you want to link a piece of your story to
+a note defining a story element, like a character, you create a :term:`reference` back to that tag.
+You can also cross-link your project notes in the same way.
+
+This is perhaps one of the features that makes novelWriter different from other, similar
+applications. It is therefore not always obvious to new users how this is supposed to work, so
+this chapter hopes to explains in more detail how to use the tags and references system.
+
+.. tip::
+   If you find the Tags and Reference system difficult to follow just from reading this chapter,
+   you can create a new project in novelWriter and select to "Fill the project with example files"
+   in the :guilabel:`New Project Wizard`. 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 documents.
+
+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 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.
+
+The implication here is that you can treat each heading as an independent element of your notes
+that can be referenced somewhere else. In order to make it possible to reference a header section,
+you need to assign it a tag.
+
+
+.. _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 ``@tags`` :term:`keyword`. The full format of a tag is ``@tag: tagname``, where
+``tagname`` is an identifier of your choosing. You can only set *one* tag per heading, and the tag
+has to be unique across all documents in the project.
+
+.. note::
+   In version 2.2, tags will be made case insensitive, but as of novelWriter 2.1 they are not. You
+   should however avoid using tags that are only distinguished by case.
+
+After the tags have been defined, they can then be referenced in the novel documents, or
+cross-referenced in other notes. they will also show up in the :guilabel:`Outline View` and in the
+back-reference panel when a document is opened in the viewer.
+
+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 syntax
+colour that valid tags do.
+
+The tag is the only part of these notes that the novelWriter 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:`Manuscript Build` tool.
+
+Example of a heading with a tag for a character of the story:
+
+.. code-block:: none
+
+   # Jane Doe
+
+   @tag: Jane
+
+   Some information about the character Jane Doe.
+
+When this is done in a document in a :term:`Root Folder` of type "Characters", the tag is
+automatically treated as an available character in your project, and you will be able to reference
+it in any of your other documents using the reference keywords for characters.
+
+It 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 availabe 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 :guilabel:`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
+   :guilabel:`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 :guilabel:`Character`
+   type root folder.
+
+``@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.
+
+``@plot``
+   The plot or subplot advanced in the current section. The target must be a note tag in a
+   :guilabel:`Plot` type root folder.
+
+``@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.
+
+.. 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 :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.
+
+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 :guilabel:`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
+   :guilabel:`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:: none
+
+   ## Chapter 1
+
+   @pov: Jane
+
+   ### Scene 1
+
+   @char: John, Sam
+   @plot: Main
+
+   Once upon a time ...

docs/source/project_structure.rst

@@ -0,0 +1,113 @@
+.. _a_struct:
+
+***************
+Novel Structure
+***************
+
+This chapter covers the structure of a novel project.
+
+There are two different types of documents in a project, :guilabel:`Novel Documents` and
+:guilabel:`Project Notes`. 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.
+
+The :guilabel:`Project Tree` can distinguish between the different header levels of the novel
+documents using coloured icons, and optionally add emphasis on the label, set in
+:guilabel:`Preferences`.
+
+
+.. _a_struct_heads:
+
+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 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 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 :guilabel:`Outline View` as well as in the
+   :guilabel:`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 header types, and the two special header 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
+   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 ``#!`` 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.
+
+**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.
+
+**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 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.
+
+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
+:guilabel:`Manuscript Build` tool. 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
+   instance, chapter numbers can be applied automatically, and so can scene numbers if you want
+   them in a draft manuscript. See the :ref:`a_manuscript` page for more details.
+
+
+.. _a_struct_heads_title:
+
+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
+render it as a document title that is excluded from any automatic Table of Content in a manuscript
+build document, like so:
+
+``#! My Novel``
+
+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
+before the text. See also :ref:`a_fmt_break`.
+
+
+.. _a_struct_heads_unnum:
+
+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 an ``!`` to the level 2 header formatting code to tell the
+build tool to skip these chapters.
+
+``##! Unnumbered Chapter Title``
+
+There is a separate formatting feature for such chapters in the :guilabel:`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 will have a page break added just like for
+normal chapters.
+
+.. 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.

docs/source/projects.rst

@@ -1,296 +0,0 @@
-.. _a_proj:
-
-**************
-Novel Projects
-**************
-
-A novelWriter project requires a dedicated folder for storing its files on the local file system.
-See the :ref:`a_tech` page for further details on how files are organised.
-
-A new project can be created from the :guilabel:`Project` menu by selecting :guilabel:`New Project`.
-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.
-
-The 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.
-
-
-.. _a_proj_roots:
-
-Project Roots
-=============
-
-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 core novel files go into a root folder of type :guilabel:`Novel`. Other supporting files go into
-the other root folders. These other root folder types are intended for your notes on the various
-elements of your story. Using these is of course entirely optional.
-
-A new project will not have all of the root folders present, but you can add the ones you want from
-:guilabel:`Create Root Folder` in the :guilabel:`Project` menu.
-
-The root folders are intended for the following use, but aside from the :guilabel:`Novel` folder, no
-restrictions are enforced by the application. You can use them however you want.
-
-:guilabel:`Novel`
-   This is the root folder of all text that goes into the final novel. This class of files have
-   other rules and features than other files in the project. See the :ref:`a_struct` page for more
-   details.
-
-:guilabel:`Plot`
-   This is the root folder where main plots can be outlined. It is optional, but adding at least
-   dummy files 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 files go in this root folder. These are especially important if one wants 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. Tags in this folder can be references using the ``@pov``
-   keyword for point-of-view characters, or the ``@char`` keyword for other characters.
-
-: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.
-
-:guilabel:`Timeline`
-   If the story has multiple plot timelines or jumps in time within the same plot, this class of
-   files can be used to track this. Tags in this 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.
-
-:guilabel:`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 ``@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.
-
-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`.
-
-.. tip::
-   You can rename root folders to whatever you want. The first character in the :guilabel:`Flags`
-   column will still indicate what type they are, and so will the icon if you are using one of the
-   Typicons icon sets.
-
-
-.. _a_proj_roots_del:
-
-Deleted Documents
------------------
-
-Deleted document files will be moved into a special :guilabel:`Trash` root folder. Files in the
-trash folder can then be deleted permanently, either individually, or by emptying the trash from the
-menu.
-
-Folders and root folders can only be deleted when they are empty. Recursive deletion is not
-supported.
-
-A document file or a folder can be deleted from the :guilabel:`project` menu, or by pressing
-:kbd:`Ctrl`:kbd:`Del`.
-
-
-.. _a_proj_roots_orph:
-
-Orphaned 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 isn't
-tracked in the core project file. These files, when discovered, are handled by the Orphaned
-Documents routine.
-
-Files that are discovered in the project folder, but not in the project, will be re-added to the
-project tree in a special :guilabel:`Orphaned Items` root folder next time the application is
-started. These orphaned files will not have most of the meta data preserved, although novelWriter
-will try to restore the file label it had in the project tree. Other information will have to be set
-again, and the files moved back to the correct location in the project tree.
-
-
-.. _a_proj_roots_lock:
-
-Project Lockfile
-----------------
-
-To prevent orphaned files 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.
-
-.. 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.
-
-
-.. _a_proj_roots_dirs:
-
-Using Folders in the Project Tree
----------------------------------
-
-Folders, aside from root folders, have no structural significance to the project. When novelWriter
-is processing the files in the novel, like for instance during export, these folders are ignored.
-Only the order of the document files themselves matter.
-
-The folders are there purely as a way for the user to organise the files in meaningful sections and
-to be able to collapse and hide them in the project tree when you're not working on those files.
-
-.. tip::
-   You can use folders to sort your scene files into chapters. You will then need to add a chapter
-   file as the first file of your folder, and the scene files as the following files.
-
-
-.. _a_proj_files:
-
-Project Files
-=============
-
-New document files can be created from the :guilabel:`Document` menu, or by pressing
-:kbd:`Ctrl`:kbd:`N` while in the Project Tree. This will create a new, empty file, and open the
-:guilabel:`:Item Settings` dialog where the filename and various other settings can be changed.
-This dialog can also be opened again later from either the :guilabel:`Project` menu, selecting
-:guilabel:`Edit Item`, or by pressing :kbd:`Ctrl`:kbd:`E` or :kbd:`F2` with the item selected.
-
-The layout of the file is also defined here. For Novel files, the full list of layout options are
-available. For non-Novel files, only "Note" is available. See :ref:`a_struct_layout` for more
-details.
-
-You can also select whether the file is by default included when building the project. This setting
-can be overridden in the :guilabel:`Build Novel Project` tool if you wish to include them anyway.
-This is covered in the :ref:`a_export_files` section.
-
-
-.. _a_proj_files_counts:
-
-Word Counts
------------
-
-A character, word and paragraph count is maintained for each file, as well as dor each section of a
-file defined by 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 file selected.
-
-The word counts are not updated in real time, but runs in the background every five 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`.
-
-
-.. _a_proj_settings:
-
-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.
-
-
-Settings Tab
-------------
-
-The :guilabel:`Settings` tab holds the project title and author settings.
-
-The :guilabel:`Working Title` can be set to a different title than the :guilabel:`Book Title`. The
-difference between them is simply that the :guilabel:`Working Title` is used for the GUI (main
-window title) and for generating the backup files. The intention is that the :guilabel:`Working
-Title` should remain unchanged throughput the project, otherwise the name of exported files and
-backup files may change too.
-
-The :guilabel:`Book Title` and :guilabel:`Book Authors` settings are currently not used for
-anything, so setting then is just for the benefit of the author. Future, planned features will be
-using them, and they are exported on some export formats in the :guilabel:`Build Novel Project`
-tool.
-
-
-Details Tab
------------
-
-This tab presents an overview of meta data for the project. It states where on your file system the
-project is saved, how may times it has been saved, how many folders and files it contains, and how
-many words exist in the entire project.
-
-
-Status and Importance Tabs
---------------------------
-
-Each file of type "Novel" can be given a status level, signified by a coloured icon and each file of
-the remaining types can be given an importance level. These are colour coded icons and labels that
-can be applied to each file.
-
-These are purely there for the user's convenience, and you are not required to use them for any
-other feature to work. No other part of novelWriter accesses this information. The intention is to
-use these to indicate at what stage of completeion each novel file is, or how important the content
-of a note file is to the plot. 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.
-
-.. note::
-   The status or importance level currently in use by one or more files cannot be deleted, but they
-   can be edited.
-
-
-Auto-Replace Tab
-----------------
-
-A set of automatically replaced keywords can be added in this tab. The keywords in the left column
-will be replaced by the text in the right column when documents are opened in the viewer. They will
-also be applied to exports.
-
-.. note::
-   A keyword cannot contain any spaces. The angle brackets are added by default, and when used in
-   the text are a part of the keyword to be replaced. This is to ensure that parts of the text isn't
-   unintentionally replaced by the content of the list.
-
-
-.. _a_proj_backup:
-
-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 to be provided in :guilabel:`Preferences`.
-
-Backups can be run automatically when a project is closed, which also implies it is run when the
-application is closed. Backups are date stamped zip files of the entire project folder, and are
-stored in a subfolder of the backup path with the same name as the project :guilabel:`Working Title`
-set 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 dissable automated backup for a given project in :guilabel:`Project
-Settings`.
-
-.. note::
-   For the backup to be able to run, the :guilabel:`Working Title` 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 produce a warning message.
-
-.. _a_proj_stats:
-
-Writing Statistics
-==================
-
-When you work on your project, a log file records when you opened it, when you closed it, and how
-many words you added to your novel and note files during the session. You can view this file in the
-``meta`` folder in the directory where you saved your project. The file is named
-``sessionStats.log``.
-
-A small 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`.
-
-The tool will show a list of all your sessions, and a set of filters to apply to it. 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.

docs/source/requirements.txt

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

docs/source/started.rst

@@ -1,186 +0,0 @@
-.. _a_started:
-
-***************
-Getting Started
-***************
-
-This is a brief guide to how you can get novelWriter running on your computer. These are the methods
-currently supported by the developer. Packages may also be available in other package managers, but
-those are not managed by me.
-
-As novelWriter matures, more options for how to install it and get it running will be added. At the
-present time, the process is best suited for people used to work with Python projects from command
-line.
-
-
-.. _a_started_install:
-
-Installation
-============
-
-You can download the latest version of novelWriter from the source repository on GitHub_. You can
-also install it directly from PyPi with ``pip install novelwriter``, or download the packages
-directly from the PyPi_ project page.
-
-Latest version of novelWriter is |release|.
-
-.. _GitHub: https://github.com/vkbo/novelWriter/releases
-.. _PyPi: https://pypi.org/project/novelWriter/
-
-
-.. _a_started_depend:
-
-Dependencies
-============
-
-novelWriter has been designed to rely on as few dependencies as possible. Aside from the package(s)
-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.
-
-Optionally, a package can be installed to interface with the Enchant spell checking libaries, but
-this isn't strictly required. If no external spell checking library is available, novelWriter falls
-back to using the internal ``difflib`` of Python to check spelling. This is a much slower approach,
-and it is less sophisticated than full spell checking libaries, but if you only work with small
-files, the performance loss is not noticeable.
-
-
-.. _a_started_depend_packages:
-
-Package Installation
---------------------
-
-If you already have Python installed, all you need to do is install the dependencies. To do this,
-you need to open your command line tool, find the folder where you extracted novelWriter, and run
-the following command:
-
-.. code-block:: console
-
-   pip install -r requirements.txt
-
-This will install all the dependencies and recommended packages.
-
-The following Python packages are required to run novelWriter:
-
-* ``pyqt5``, needed for connecting with the Qt5 libraries.
-* ``lxml``, needed full XML support.
-
-You can of course also install these packages from your operating system's package repository.
-
-.. note::
-   Sometimes the SVG graphics package for PyQt5 must be installed separately. It is usually called
-   something like ``python3-pyqt5.qtsvg``.
-
-PyQt/Qt should be at least 5.2.1, but ideally 5.10 or higher for nearly all features to work.
-Exporting to standard Markdown, for instance, requires PyQt/Qt 5.14. Searching using regular
-expressions requires 5.3, and for full Unicode support, 5.13.
-
-There are 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.
-
-The spell checking extension is optional, but recommended:
-
-* ``pyenchant``, needed for efficient spell checking.
-
-The optional spell check library must be at least 3.0.0 to work with Windows. On Linux, 2.0.0 also
-works fine.
-
-
-.. _a_started_depend_docs:
-
-Building the Documentation
---------------------------
-
-If you installed novelWriter from a package, the documentation should be included. If you're running
-novelWriter from the source code, a local copy of this documentation can be generated. It requires
-the following Python packages on Debian and Ubuntu.
-
-* ``python3-sphinx``
-* ``python3-sphinxcontrib.qthelp``
-
-Or from PyPi:
-
-.. code-block:: console
-
-   pip install sphinx sphinxcontrib-qthelp
-
-To build the help packages from the documentation source, run
-
-.. code-block:: console
-
-   ./setup.py qthelp
-
-from the root source folder.
-
-The setup script will copy the generated files into the ``nw/assets/help`` folder, and novelWriter
-will detect the presence of the files and redirect the menu help entry to open help locally instead
-of sending the user to the website. Pressing the :kbd:`F1` key will in any case try to open help
-locally first, then send you to the website as a fallback.
-
-.. note::
-   In order for the local version of help to work, the Qt Assistant must be installed on the local
-   computer. If it isn't available, or novelWriter cannot find it, the help feature will fall back
-   to redirecting you to the documentation website.
-
-
-.. _a_started_running:
-
-Running novelWriter
-===================
-
-If all the required dependencies are met, you can run novelWriter from the command line in one of
-the following ways:
-
-.. code-block:: console
-
-   python novelWriter.py
-   python3 novelWriter.py
-   ./novelWriter.py
-
-A few switches are supported from the command line, mostly to assist in debugging if an error is
-encountered. To list all options, run:
-
-.. code-block:: console
-
-   python novelWriter.py --help
-
-There are also a couple of install scripts in the assets folder which will assist in setting up a
-launch icon and the novelWriter project file mimetype for Gnome desktops on Linux. Currently,
-there's one script for Debian and one for Ubuntu.
-
-
-.. _a_started_standalone:
-
-Building a Standalone Executable
-================================
-
-A standalone executable can be built with ``pyinstaller``, using the provided python script
-``install.py`` in the source folder. This script will automatically try to install all dependencies
-and build the standalone executable of novelWriter. You can run the script by typing the following
-into your command prompt:
-
-.. code-block:: console
-
-   python install.py
-
-If successful, the executable will be in the "dist" folder.
-
-
-.. _a_started_standalone_win:
-
-Additional Instructions for Windows
------------------------------------
-
-If you don't have Python installed, you can download it from the python.org website. The installers
-for Windows are available at https://www.python.org/downloads/windows/
-
-novelWriter should work with Python 3.6 or higher, and the executable installer is the easiest to
-install.
-
-Also, make sure you select the "Add Python to PATH" option.
-
-.. image:: images/python_win_install.png
-   :width: 600
-
-Once Python is set up and running, you can either run novelWriter from the folder where you
-extracted it, or you can build an executable and run that from a desktop icon instead.

docs/source/structure.rst

@@ -1,198 +0,0 @@
-.. _a_struct:
-
-***************
-Novel Structure
-***************
-
-This section covers the structure of a novel project.
-
-This section concerns files under the Novel type root folder only. There are some restrictions
-and features that only applies to these type of files.
-
-
-.. _a_struct_heads:
-
-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 document files.
-
-Four levels of headings are supported, signified by the number of hashes preceding the title. See
-also the :ref:`a_ui_md` section for more details about the markdown syntax.
-
-.. note::
-   The header levels are not only important when generating the exported novel file, they are also
-   used by the indexer when building the outline tree in the :guilabel:`Outline` tab. Each heading
-   also starts a new region where new references to tags can be set.
-
-The different header levels are interpreted as specific section types of the novel in the following
-way:
-
-``# Header1``
-   Header level one signifies that the text refers to either the novel title or the name of a top
-   level partition when you want to split the manuscript up into books, parts, or acts.
-
-``## Header2``
-   Header level two 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 file per scene,
-   you need a single chapeter file with just the heading. You can of course also add a synopsis and
-   reference keywords to the chapter file. If you want to open the chaper with a quote, this is
-   also where you'd put the text for that.
-
-``### Header3``
-   Header level three signifies a scene level partition. The title itself can be replaced with a
-   scene separator or just skipped entirely when you export your manuscript.
-
-``#### Header4``
-   Header level four signifies a sub-scene level partition, usually called just a section in the
-   documentation und user interface. These can be useful if you want to change tag references
-   mid-scene, like if you change the point-of-view character. You are free to use sections as you
-   wish also in novel files, and can filter the titles out of the final manuscript just like with
-   scene titles.
-
-There are multiple options of how to process novel titles when exporting 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.
-
-
-.. _a_struct_tags:
-
-Tag References
-==============
-
-Each text section indicated by a heading of any level, can contain references to tags set in the
-supporting files of the project. The references are gathered by the indexer and used to generate the
-outline view on the :guilabel:`Outline` tab of how the different parts of the novel are connected.
-
-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.
-
-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.
-
-``@pov``
-   The point-of-view character for the current section. The target must be a note tag in the
-   :guilabel:`Character` type root folder.
-
-``@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 character(s).
-
-``@plot``
-   The plot or subplot advanced in the current section. The target must be a note tag in a
-   :guilabel:`Plot` type root folder.
-
-``@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 an :guilabel:`Object`
-   type root folder.
-
-``@entity``
-   Entities present in the current section. The target must be a note tag in an :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 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 file is regenerated when a file is saved, so this shouldn't normally be necessary.
-
-
-.. _a_struct_layout:
-
-Novel File Layout
-=================
-
-All files in a novelWriter project can have a layout format set. These layouts are important when
-the project is exported as they indicate how to treat the content in terms of formatting, headings,
-and page breaks. The layout for each file is indicated as the last set of characters in the
-:guilabel:`Flags` column of the project tree.
-
-Not all layout types are actually treated differently, but they also help to indicate what each file
-is for in your project. The :guilabel:`Book` layout is a generic novel file layout that is formatted
-identically to :guilabel:`Chapter` and :guilabel:`Scene` layout files, but may help to indicate what
-files do in your project.
-
-You can for instance lay out your project using :guilabel:`Book` files for each act, and then later
-split those into chapter or scene files by using the :guilabel:`Split Document` tool. Scenes can
-also be contained within :guilabel:`Chapter` type files, but you lose the drag and drop feature that
-comes with having them in separate files if you organise them this way.
-
-Some layouts *do* have implications on how the project is exported. Files with layout
-:guilabel:`Title Page` and :guilabel:`Partition` have all headings and text centred, while the
-:guilabel:`Unnumbered` layout disables the automatic chapter numbering feature for everything
-contained within it. The latter is convenient for Prologue and Epilogue type chapters.
-
-All of the above layout formats are only usable in the Novel root folder. Files that are not a part
-of the novel itself should have the Note layout. These files are not getting any special formatting,
-and it is possible to collectively filter them out during export. Note files can be used anywhere
-in the project, also in the Novel root folder.
-
-Below is an overview of all available layout formats.
-
-:guilabel:`Title Page`
-   The title page layout. The title should be formatted as a heading level one. All text is
-   automatically centred on exports.
-
-:guilabel:`Plain Page`
-   A plain page layout useful for instance for front matter pages. Heading levels are ignored for
-   this layout format, and so are formatting options like :guilabel:`Justify Text`. The page is
-   exported with a page break before it.
-
-:guilabel:`Book`
-   This is the generic novel file format that in principle can be used for all novel files. Since
-   the internal structure of the novel is controlled by the heading levels, this file will produce
-   the same result as a collection of :guilabel:`Partition`, :guilabel:`Chapter` and
-   :guilabel:`Scene` type files. However, it does not provide the functionality of the
-   :guilabel:`Unnumbered` layout format.
-
-:guilabel:`Partition`
-   A partition can be used to split the novel into parts. Partition titles are indicated with a
-   level one heading. You can also add text and meta data to the page. The :guilabel:`Partition`
-   file layout will in addition force a page break before the heading, and centre all content on the
-   page.
-
-:guilabel:`Chapter`
-   Signifies the start of a new chapter. If the text itself is contained in scene files, these files
-   should only contain the title, comments, synopsis, and tag references for characters, plot, etc.
-   The heading for chapters should be level two. If you need an opening text, like a quote or other
-   leading text before the first scene, this is also where you'd want to add this text.
-
-:guilabel:`Unnumbered`
-   Same as :guilabel:`Chapter`, but when exporting the files and automatic chapter numbering is
-   enabled, this file will not increment the chapeter number. It also has a separate title
-   formatting setting. This makes the layout suitable for Prologue and Epilogue type chapters.
-
-:guilabel:`Scene`
-   A scene file. This file should have a header of level three. Further sections can have headers
-   of level four, but there are no file layout specifically for sections.
-
-:guilabel:`Note`
-   A generic file that is optionally ignored when the novel is exported. Use these files for
-   descriptions of content in the supporting root folders. Note files can also be added to the Novel
-   root folder if you need to insert notes there. Note file headers receive no special formatting
-   when building the project. They are always exported as-is.
-
-.. note::
-   The layout granularity is entirely optional. In principle, you can write the entire novel in a
-   single file with layout :guilabel:`Book`. You can also have a single file per chapter if that
-   suits you better. The :guilabel:`Outline` will show your structure of chapters and scenes
-   regardless of how your files are organised.
-
-.. tip::
-   You can always start writing with a coarse file layout with one or a few files, and then later
-   use the split tool to automatically split the files into chapter and scene files.