Merge pull request #797 from vkbo/release_1.3.2

Release 1.3.2

.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

@@ -0,0 +1,16 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: ""
+labels: bug
+---
+
+**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:
+
+* 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

@@ -0,0 +1,15 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: ""
+labels: enhancement
+---
+
+**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:
+
+* 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/workflows/syntax.yml

@@ -0,0 +1,29 @@
+name: flake8
+
+on:
+  push:
+    branches: [ main, testing, dev ]
+  pull_request:
+    branches: [ main, testing, dev ]
+
+jobs:
+  checkSyntax:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3
+          architecture: x64
+      - name: Checkout Source
+        uses: actions/checkout@v2
+      - name: Install flake8
+        run: pip install flake8
+      - name: Syntax Error Check
+        run: |
+          flake8 nw --count --select=E9,F63,F7,F82 --show-source --statistics
+          flake8 tests --count --select=E9,F63,F7,F82 --show-source --statistics
+      - name: Coding Style Violations
+        run: | 
+          flake8 nw --count --max-line-length=99 --ignore E203,E221,E226,E228,E241,E251,E261,E266,E302,E305 --show-source --statistics
+          flake8 tests --count --max-line-length=99 --ignore E203,E221,E226,E228,E241,E251,E261,E266,E302,E305 --show-source --statistics

.github/workflows/test_linux.yml

@@ -0,0 +1,42 @@
+name: Linux
+
+on:
+  push:
+    branches: [ main, testing, dev ]
+  pull_request:
+    branches: [ main, testing, dev ]
+
+jobs:
+  testLinux:
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+      - name: Install Packages (apt)
+        run: |
+          sudo apt update
+          sudo apt install libenchant-dev qt5-default qttools5-dev-tools
+      - name: Checkout Source
+        uses: actions/checkout@v2
+      - name: Install Dependencies (pip)
+        run: |
+          pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pytest-timeout
+          pip install pytest-cov
+          pip install pytest-qt
+          pip install codecov
+      - name: Run Build Commands
+        run: python setup.py qtlrelease sample
+      - name: Run Tests
+        run: |
+          export QT_QPA_PLATFORM=offscreen
+          pytest -v --cov=nw --timeout=60
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v1

.github/workflows/test_mac.yml

@@ -0,0 +1,37 @@
+name: macOS
+
+on:
+  push:
+    branches: [ main, testing, dev ]
+  pull_request:
+    branches: [ main, testing, dev ]
+
+jobs:
+  testMac:
+    runs-on: macos-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+          architecture: x64
+      - name: Install Packages
+        run: |
+          brew install enchant
+      - name: Checkout Source
+        uses: actions/checkout@v2
+      - name: Install Dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pyobjc
+          pip install pytest-timeout
+          pip install pytest-cov
+          pip install pytest-qt
+          pip install codecov
+      - name: Run Tests
+        run: |
+          export QT_QPA_PLATFORM=offscreen
+          pytest -v --cov=nw --timeout=60
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v1

.github/workflows/test_win.yml

@@ -0,0 +1,32 @@
+name: Windows
+
+on:
+  push:
+    branches: [ main, testing, dev ]
+  pull_request:
+    branches: [ main, testing, dev ]
+
+jobs:
+  testWin:
+    runs-on: windows-latest
+    steps:
+      - name: Python Setup
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+          architecture: x64
+      - name: Checkout Source
+        uses: actions/checkout@v2
+      - name: Install Dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pytest-timeout
+          pip install pytest-cov
+          pip install pytest-qt
+          pip install codecov
+      - name: Run Tests
+        run: |
+          pytest -v --cov=nw --timeout=60
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v1

.gitignore

@@ -1,28 +1,50 @@
 # Setup/Install
-MANIFEST
-dist/
-build/
-deploy/
+/MANIFEST
+/dist/
+/build/
+/deploy/
 *.spec
 *.egg-info
+setup.iss
+novelwriter.desktop
+novelWriter.pyw
+
+# Translations
+/nw/assets/i18n/*.qm
+.qmake.stash
+i18n/*.qm
+i18n/*.qph
 
 # Documentation
-docs/build/
+/docs/build/
+*.qch
+*.qhc
 
 # Python Temp
 __pycache__
+*.pyc
 
 # Sample Project
-sample/**/cache
-sample/**/wordlist.txt
-sample/**/sessionInfo.log
-sample/**/*.bak
-sample/**/*.json
+/nw/assets/sample.zip
+/sample/cache
+/sample/meta
+/sample/versions
+*.bak
+*.lock
+ToC.txt
 
 # PyTest
-tests/temp
-.pytest_cache
-pytestdebug.log
+/prof/
+/htmlcov/
+/tests/temp
+/tests/lipsum/cache
+/tests/lipsum/meta
+/tests/minimal/cache
+/tests/minimal/meta
+/tests/oldproj/cache
+/.pytest_cache
+/pytestdebug.log
 
 # Coverage
-.coverage
+/.coverage
+/coverage.*

.readthedocs.yml

@@ -0,0 +1,25 @@
+# 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,30 +0,0 @@
-os: linux
-dist: xenial
-services:
-  - xvfb
-language: python
-cache: bundler
-sudo: required
-addons:
-  apt:
-    packages:
-      - libenchant-dev
-      - python3-pyqt5
-      - python3-pyqt5.qtsvg
-python:
-  - "3.5"
-  - "3.7"
-install:
-  - pip install -r requirements.txt
-# - pip install pytest-faulthandler
-  - pip install pytest-xvfb
-  - pip install pytest-cov
-  - pip install pytest-qt
-  - pip install codecov
-script:
-  - python -m pytest --cov=nw -m "project|core|gui" -v
-after_success:
-  - codecov
-after_failure:
-  - cat /sys/fs/cgroup/memory/memory.max_usage_in_bytes
-

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## 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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+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
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/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
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our 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.
+
+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.
+
+## 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.
+
+## 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.
+
+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.
+
+## 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
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,143 @@
+# Contributing Guide
+
+When contributing to this repository, please first discuss the change you wish to make via the
+issue tracker or the discussions page with the owner of this repository 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.
+
+## Branching Structure
+
+There are three protected branches on this repository. They are used in the following way:
+
+* `main` – This is the Stable branch. It is used for releases and subsequent patches. No
+  development code should be merged into this branch starting from version 1.0.
+* `dev` – This is the Unstable (development) branch. It is where new features are merged, and where
+  pre-releases are taken from.
+* `testing` – This is the Testing branch. It is populated from the `dev` branch for pre-releases
+  that need a longer testing phase.
+
+Stable releases and patches will be tagged in the `main` branch, pre-releases may be tagged from
+either `testing` or `dev` branch.
+
+### What Branch to Use for Contributions
+
+* If your contribution is a fix for the latest stable release, branch from the `main` branch.
+* If your contribution is a fix for the latest testing release, branch from the `testing` branch.
+* If your contribution is a new feature, branch from the `dev` branch.
+
+## Pull Request Process
+
+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. Version numbers are bumped in separate release pull requests
+   by the maintainer.
+
+## 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.
+
+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 listed below.
+
+### Line Length
+
+For this project, source lines should stay within the 79 and 99 character limits described by PEP8.
+79 characters is often too restrictive, so 99 character lines 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, not 99. If wrapping can be avoided by going to 99, then that is
+generally preferrable.
+
+For text files, the text should also be wrapped at 99 character. The exception is markdown image
+tags and urls.
+
+Please do not submit pull requests that re-wrap existing source or text unless this has been
+discussed beforehand.
+
+### Linting with `flake8`
+
+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/).
+
+The `setup.cfg` file in the root of this project has the following settings for `flake8` that
+matches the coding standard:
+```conf
+[flake8]
+ignore = E203,E221,E226,E228,E241,E251,E261,E266,E302,E305
+max-line-length = 99
+exclude = docs/*
+```
+
+The command line equivalent, with reporting, is:
+```bash
+flake8 . --count --ignore E203,E221,E226,E228,E241,E251,E261,E266,E302,E305 --max-line-length=99 --show-source --statistics
+```
+
+Passing this check is required before contributions 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.
+
+## Ignored Errors
+
+Some `flake8` error codes are ignored for this project for various reasons. The source also uses
+camelCase function and variable names. This is the standard for the Qt libraries novelWriter
+integrates with. It also happens to be 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, like for instance for Go. 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.
+
+**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.
+
+**E228** missing whitespace around modulo operator  
+**Reason:** See reason for E226. Formatting `%` like `/` and `*` should be possible.
+
+**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 doesn't make much sense.
+
+**E266:** too many leading ‘#’ for block comment  
+**Reason:** In the source multiple `#`s is sometimes used to indicate importance or heading level,
+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 see 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`, preferably indented at function
+level. The end of the function is then clear.

MANIFEST.in

@@ -1,3 +1,6 @@
+include setup.py
 include LICENSE.md
-recursive-include nw/graphics *
-recursive-include nw/themes *
+include CHANGELOG.md
+recursive-include setup *
+recursive-include nw/assets *
+recursive-include sample *.nwx *.nwd

README.md

@@ -1,138 +1,230 @@
 # novelWriter
 
-[![Build Status](https://travis-ci.com/vkbo/novelWriter.svg?branch=master)](https://travis-ci.com/vkbo/novelWriter)
-[![codecov](https://codecov.io/gh/vkbo/novelWriter/branch/master/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)
+[![Linux](https://github.com/vkbo/novelWriter/actions/workflows/test_linux.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_linux.yml)
+[![Windows](https://github.com/vkbo/novelWriter/actions/workflows/test_win.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_win.yml)
+[![macOS](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml/badge.svg?branch=main)](https://github.com/vkbo/novelWriter/actions/workflows/test_mac.yml)
+[![flake8](https://github.com/vkbo/novelWriter/workflows/flake8/badge.svg)](https://github.com/vkbo/novelWriter/actions)
+[![codecov](https://codecov.io/gh/vkbo/novelWriter/branch/main/graph/badge.svg)](https://codecov.io/gh/vkbo/novelWriter)
+[![docs](https://readthedocs.org/projects/novelwriter/badge/?version=latest)](https://novelwriter.readthedocs.io/en/latest/?badge=latest)  
+[![release](https://img.shields.io/github/v/release/vkbo/novelwriter)](https://github.com/vkbo/novelWriter/releases)
+[![pypi](https://img.shields.io/pypi/v/novelwriter)](https://pypi.org/project/novelWriter)
+[![python](https://img.shields.io/pypi/pyversions/novelwriter)](https://pypi.org/project/novelWriter)
 
-novelWriter is a markdown-like text editor designed fro writing novels and larger projects of many smaller plain text documents.
+<img align="left" style="margin: 0 16px 4px 0;" src="https://raw.githubusercontent.com/vkbo/novelWriter/main/setup/icons/scaled/icon-novelwriter-96.png">
 
-The documentation is available here: [novelwriter.readthedocs.io](https://novelwriter.readthedocs.io/).
+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.
 
-### Note
+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 application is under initial development, and not all planned features are included.
-The core functionality is, however, in place and has been used for a while by the author and collaborators.
-
-New features are being added regularly, until the core toolset is complete.
-When all planned initial features are in place, a release 1.0 will be made.
-Until then, novelWriter is in a pre-release alpha state, and should be considered experimental.
-If you do use it for real projects, please run backups frequently to avoid data losses.
-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.
+The full documentation is available on [readthedocs.io](https://novelwriter.readthedocs.io).
 
 ## 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.
+The application is written in Python 3 (3.6+) using Qt5 and PyQt5 (5.3+). It is developed on Linux,
+but should in principle work fine on other operating systems as well as long as dependencies are
+met. It is regularly tested on Debian and Ubuntu Linux, Windows, and macOS.
 
-The application can be started from the source folder with the command:
-```
-./novelWriter.py
-```
+## Project Contributions
 
-It also takes a few parameters for debugging and such, which can be listed with the switch `--help`.
+The project isn't taking feature contributions at the moment. If you have an idea, please make a
+feature request in the issue tracker. Fixes and patches are welcome. So are new translations.
+Contributions related to packaging and installing novelWriter will also be appreciated.
 
-There are no launcher icons yet.
-Consult your operating system documentation for how to make those.
-These will be added at some point, and I would appreciate any assistance from people working on Windows and MacOS as I don't use either of those operating systems.
+If you want to help translating novelWriter into another language, please see the
+[README](https://github.com/vkbo/novelWriter/blob/main/i18n/README.md) in the `nw/assets/i18n`
+folder for further details.
 
-## Dependencies
-
-For the apt package manager on Debian systems, the following Python3 packages are needed:
-
-* `python3-pyqt5` for the GUI
-* `python3-pyqt5.qtsvg` may need to be installed separately
-* `python3-appdirs` for locating the system's config folder
-* `python3-lxml` for writing project files
-
-These are optional, but recommended:
-
-* `python3-enchant` for spell checking
-* `python3-pycountry` for translating language codes to language names
-* `python3-latexcodec` for escaping unicode characters in LaTeX export
-* `python3-pandoc` for additional exports to Word, Open Office, eBooks, etc.
-
-Alternatively, the packages can be installed with `pip` by running
-```
-python3 -m 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:
-```
-python3 -m pip install pyqt5
-python3 -m pip install appdirs
-python3 -m pip install lxml
-python3 -m pip install pyenchant
-python3 -m pip install pycountry
-python3 -m pip install latexcodec
-python3 -m pip install pypandoc
-```
-On Windows,`pyenchant` may cause problems.
-I'm looking for a good alternative for spell checking.
-
-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
-```
+Before contributing any code, please read the full
+[Contributing Guide](https://github.com/vkbo/novelWriter/blob/main/CONTRIBUTING.md).
 
 ## Key Features
 
-The text documents of novelWriter uses a format similar to markdown, but with a few extensions and a few omissions.
-Project meta data is stored as XML.
+Some key features of novelWriter are listed below. Consult the
+[documentation](https://novelwriter.readthedocs.io) for more information.
+
+### Markdown Flavour
+
+Note that novelWriter is _not_ a proper Markdown editor. It is a plain text editor that uses
+Markdown-like syntax to allow for a minimal set of formatting that is useful for the specific task
+of writing novels. The formatting is currently limited to:
+
+* Headings levels 1 to 4 using the `#` syntax only.
+* Emphasised and strongly emphasised text. These are rendered as italicised and bold text.
+* 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 syntax used for its additional features:
+
+* A line starting with `%` is treated as a comment and not rendered on exports unless requested.
+  Comments do not count towards word counts and other statistics.
+* If the first word of the comment is `synopsis:`, the comment is indexed and treated as the
+  synopsis for the section of text where it occurs. These synopsis comments can be used to build an
+  outline and exported to external documents.
+* A set of meta data keyword/values starting with the character `@`. These are used for tagging
+  and inter-linking documents, and can also be included when generating a project outline.
+* A variety of thin and non-breaking spaces are supported. Some of them depend on the system
+  running at least Qt 5.9. Earlier versions of Qt will unfortunately strip them out when saving.
+* Tabs can be used in the text, and should be properly aligned in both editor and viewer. This can
+  be used to make simple tables and lists. Note that for HTML exports, most browsers will treat a
+  tab as a space, so it may not show up like expected. Open Document exports should produce the
+  expected result.
+
+The core export formats of novelWriter are Open Document and HTML5. Open Document is an open
+standard for office type documents that is supported by most office applications. See
+[Open Document > Application Support](https://en.wikipedia.org/wiki/OpenDocument#Application_support)
+for more details.
+
+You can also export the entire project as a single novelWriter-flavour document. These can later be
+imported again into novelWriter. In addition, printing and export to PDF is offered through the Qt
+library, although with limitations to formatting.
 
 ### Colour Themes
 
-The editor has syntax highlighting for the features it supports, and includes a set of different syntax highlighting themes.
-The GUI also has an optional dark theme in addition to the default system theme.
-
-Note that the dark theme may not render all elements of the GUI as dark colours if you are running an early version of Qt5.
-This is not due to a bug in novelWriter, but due to the fact that the the styling options in the Qt API in some versions were incomplete.
-
-New themes can easily be added to the `nw/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 if they have been altered.
-The status of this is indicated by two indicators in the right corner of the status bar.
-Unsaved changes are in yellow, and saved is indicated by green.
-Latest character count, word count, and paragraph count is shown next to these indicators in the status bar.
-The counts are updated regularly, but not as-you-type.
+The editor has syntax highlighting for the features it supports, and includes a set of different
+syntax highlighting themes. Optional GUI themes are also available, including dark themes.
 
 ### Easy Organising of Project Files
 
-The structure of the project is shown on the left hand side of the main 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 structure of the project is shown on the left hand side of the main window. Project files are
+organised into root folders, indicating what class of file they are. The most important root folder
+is the `Novel` folder, which contains all of the files that make up the novel itself. Each root
+folder can have subfolders. Subfolders have no impact on the final project structure, they are
+there for you to organise your files in whatever way you want.
 
-The editor supports four levels of headings, which 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.
+The editor supports four levels of headings, which determine what level the following text belongs
+to. Headings of level one signify a book or partition title. Headings of level two signify the
+start of a new chapter. Headings of level three signify the start of a new scene. Headings of level
+four can be used internally in each scene to create separate sections.
 
-Each novel file can be assigned a layout format, which shows up as a flag next to the item in the tree view.
-These are mostly to help the user see what they contain, but some of them have impact on the format of the exported document.
-See the documentation for further details.
+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 track what they contain, but they also have some
+impact on the format of the exported document. See the
+[documentation](https://novelwriter.readthedocs.io) for further details.
 
-#### Project Notes
+### 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.
+Supporting notes can be added for the story plot, characters, locations, story timeline, etc. These
+have their separate root folders and are optional to use.
 
 ### Visualisation of Story Elements
 
-The different notes can be assigned tags, which the novel files can refer back to using special meta keywords.
-Currently, this information can be used to display a Timeline View of the story, showing where each scene connects to the plot, and which characters, etc. occur in them.
-Further features using this meta data will be added in the future.
+The different notes can be assigned tags, which other files can refer back to using `@`-prefixed
+meta keywords. This information can be used to display an outline of the story, showing where each
+scene connects to the plot, and which characters, etc. occur in them. In addition, the tags
+themselves are clickable in the document view pane, and control-clickable in the editor. They make
+it possible to quickly navigate between the documents while writing.
 
-## Screenshot
+## Standard Installation
 
-![Screenshot 1](docs/source/images/screenshot.png)
+For a regular installation, it is recommended that you download one of the minimal zip files from
+the [Releases](https://github.com/vkbo/novelWriter/releases) page or the
+[novelwriter.io](https://novelwriter.io/) website.
+The [documentation](https://novelwriter.readthedocs.io/) has detailed install instructions for
+[Linux](https://novelwriter.readthedocs.io/en/latest/setup_linux.html),
+[Windows](https://novelwriter.readthedocs.io/en/latest/setup_windows.html), and
+[macOS](https://novelwriter.readthedocs.io/en/latest/setup_mac.html).
+They are pretty straightforward.
+
+## Running from Source
+
+If you want to run novelWriter directly from the source code, you must run the `novelWriter.py`
+file from command line.
+
+**Note:** You may need to replace `python` with `python3` and `pip` with `pip3` in the instructions
+below on some systems. You may also want to add the `--user` flag for `pip` to install in your user
+space only.
+
+### Dependencies
+
+Dependencies can generally be installed from PyPi with:
+```bash
+pip install -r requirements.txt
+```
+
+### Additional Steps for Linux
+
+On Linux, you can most likely find the dependencies in your distribution's repository. On Ubuntu
+and Debian, run:
+```bash
+sudo apt install python3-pyqt5 python3-lxml python3-enchant
+```
+
+If you want to set up a launcher and icons on Linux, you can run:
+```bash
+python setup.py xdg-install
+```
+
+### Additional Steps for macOS
+
+First, make sure you have properly set up Python3 with Homebrew. If not, check their
+[documentation](https://docs.brew.sh/Homebrew-and-Python).
+In addition, the following steps are necessary to install all dependencies:
+```bash
+brew install enchant
+pip3 install --user -r requirements.txt
+pip3 install --user pyobjc
+```
+
+### Additional Steps for Windows
+
+Windows does not by default come with Python installed. If you haven't installed it already, get it
+from [python.org/downloads](https://www.python.org/downloads/). Remember to select "Add Python to
+PATH" during the installation.
+
+The script `windows_install.bat` in the `setup` folder can be used to create desktop and start menu
+icons for novelWriter. The script will also install dependencies for you from PyPi.
+
+## Internationalisation
+
+If you install from source, you must build the translation files yourself if you want to switch to
+a different GUI language than British English. This requires that you have the Qt translation
+framework installed. Check the specific instruction in the README in the `i18n` source folder for
+how to build the translation files.
+
+## Debugging
+
+If you need to debug novelWriter, you must run it from the command line. It takes a few parameters,
+which can be listed with the switch `--help`. The `--info`, `--debug` or `--verbose` flags are
+particularly useful for increasing logging output for debugging.
+
+## Licenses
+
+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](https://github.com/vkbo/novelWriter/blob/main/LICENSE.md) file.
+
+Bundled assets have the following licenses:
+
+* The Typicons-based icon themes by Stephen Hutchings are licensed under
+  [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/). The icons have been altered in
+  size and colour for use with novelWriter, and some additional icons added. The original icon set
+  is available at
+  [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).
+
+## Screenshots
+
+**novelWriter with default system theme:**
+![Screenshot 1](https://raw.githubusercontent.com/vkbo/novelWriter/main/docs/source/images/screenshot_default.png)
+
+**novelWriter with dark theme:**
+![Screenshot 2](https://raw.githubusercontent.com/vkbo/novelWriter/main/docs/source/images/screenshot_dark.png)

codecov.yml

@@ -3,12 +3,14 @@ codecov:
 
 coverage:
   precision: 2
-  round: down
-  range: "70...100"
+  round: nearest
+  range: "70...95"
 
   status:
-    project: yes
-    patch: yes
+    project:
+      default:
+        threshold: 1%
+    patch: no
     changes: no
 
 parsers:
@@ -18,5 +20,3 @@ parsers:
       loop: yes
       method: no
       macro: no
-
-comment: false

docs/source/_static/css/custom.css

@@ -0,0 +1,27 @@
+/*
+ * 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;
+}
+
+pre span.go {
+    color: #333333 !important;
+}

docs/source/conf.py

@@ -12,97 +12,71 @@
 # 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
+import time
+import sphinx_rtd_theme # noqa: F401
 
 # -- Project information -----------------------------------------------------
 
 project = "novelWriter"
-copyright = "2018-2019, Veronica Berglyd Olsen"
+copyright = "2018–2021, Veronica Berglyd Olsen"
 author = "Veronica Berglyd Olsen"
 
 # The short X.Y version
-version = "0.4.0"
+version = "1.3.2"
 # The full version, including alpha/beta/rc tags
-release = "0.4.0"
-
+release = "1.3.2"
 
 # -- General configuration ---------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#
+os.environ["TZ"] = "Europe/Oslo"
+time.tzset()
+
 # needs_sphinx = "1.0"
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
-# ones.
 extensions = [
+    "sphinx_rtd_theme",
 ]
-
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = [".rst", ".md"]
-source_suffix = ".txt"
-
-# The master toctree document.
+source_suffix = ".rst"
 master_doc = "index"
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
+today_fmt = "%A, %d %B %Y at %H:%M"
 language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
-
-# The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
 
-
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = "default"
+html_theme = "sphinx_rtd_theme"
+html_logo = "images/novelwriter.png"
+html_theme_options = {
+    # Toc options
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 3,
+    "includehidden": True,
+    "titles_only": False,
+    "logo_only": True,
+}
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
 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"
-
+htmlhelp_basename = "novelWriterDoc"
 
 # -- Options for LaTeX output ------------------------------------------------
 
@@ -127,33 +101,28 @@ latex_elements = {
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, "novelWriter.tex", "novelWriter Documentation",
-     "Veronica Berglyd Olsen", "manual"),
-]
-
+latex_documents = [(
+    master_doc, "novelWriter.tex", "novelWriter Documentation",
+    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)
-]
-
+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"),
-]
-
+texinfo_documents = [(
+    master_doc, "novelWriter", "novelWriter Documentation", author,
+    "novelWriter", "Markdown-like editor for novels.", "Miscellaneous"
+)]
 
 # -- Options for Epub output -------------------------------------------------
 
@@ -162,11 +131,9 @@ 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.

docs/source/export.txt

@@ -1,91 +0,0 @@
-##################
-Exporting Projects
-##################
-
-The novelWriter project can be exported in various formats using the export tool available from :menuselection:`Project --> Export Project` or by pressing :kbd:`F5`.
-
-**************
-File Selection
-**************
-
-Which files are selected for export can be controlled from the "Selection" section.
-The check box for "Novel files" will select any file that isn't classified as a note.
-This is useful when exporting a document containing the novel itself.
-
-It is also possible to select the "Note files" for export, with or without the "Novel files".
-Comments can also optionally be included in the export for those formats that supports this.
-
-**************
-Export Formats
-**************
-
-Currently, five formats are supported for exporting.
-
-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.
-This is a useful format for exporting the project for later import back into novelWriter.
-
-Plain Text
-==========
-
-The plain text export format writes a simple ``.txt`` file without any formatting at all.
-Word-wrapping to a fixed column width is supported.
-It does, however, respect the centering of text if the :guilabel:`Fixed width` setting is larger than ``0``.
-
-Markdown
-========
-
-The markdown export formats writes a file using the valid markdown formats used by novelWriter, and converts comments to preformatted blocks by indenting it with four spaces.
-Word-wrapping to a fixed column width is supported.
-
-HTML5 Document
-==============
-
-The html5 export format writes a single ``.htm`` file with a minimal style settings block.
-The style setting block sets a maximum page width of ``768px``.
-Comments are exported as indented text boxes with a light yellow background.
-
-LaTeX Document
-==============
-
-The latex export formats generats a simple ``.tex`` file using a ``report`` document format.
-All chapters and sections are exported as unnumbered, and the internal header numbering formatting of novelWriter is used instead.
-Word-wrapping to a fixed column width in the LaTeX source is supported.
-
-*****************
-Header Formatting
-*****************
-
-The chapter, scene and section headers for novel files can receive some special treatment using the formats under :guilabel:`Chapter Headings` and :guilabel:`Other Headings`.
-The chapters can either be of numbered or unnumbered type, the latter being suitable for prologues, epilogues, interludes, etc.
-The headers can be generated using free text in combination with replace tags.
-The tooltip will explain which tags are available for each heading type.
-
-.. note::
-   Header formatting only applies to novel files.
-   Headings in note files will will be left as-is, but heading levels 1 through 4 are converted to the correct heading level in the respective output formats.
-
-Numbered Chapters
-=================
-
-Numbered chapters can be automatically assigned a number from 1 and upwards.
-The number is inserted in place of the ``%num%`` tag.
-Alternatively, the number can be translated to a word by using the ``%numword%`` tag.
-The word numbers feature is currently only supported in English, and works for the range from "One" to "Nine Hundred and Ninety-Nine".
-
-Unnumbered Chapters
-===================
-
-Unnumbered chapters only support the ``%title%`` tag for auto-replacement.
-
-Scenes and Sections
-===================
-
-Both scenes and sections support the ``%title%`` tag.
-In addition, scenes behave differently than the other headings when the format does not contain any auto-replace tags.
-If the text in the box is any static text, the heading formatter will treat it as a scene separator, and insert that text as centred text between scenes, and ignoring the first scene of a chapter if the chapter heading is not followed by any text.
-
-Leaving these fields blank will disable any output of scene and section headers or separators to the exported file.

docs/source/index.rst

@@ -0,0 +1,93 @@
+#####################
+novelWriter |release|
+#####################
+
+.. image:: https://github.com/vkbo/novelWriter/workflows/python%203.8/badge.svg?branch=main
+   :target: https://github.com/vkbo/novelWriter/actions
+   :alt: Python Tests
+
+.. image:: https://codecov.io/gh/vkbo/novelWriter/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/vkbo/novelWriter
+   :alt: Code Coverage
+
+.. image:: https://readthedocs.org/projects/novelwriter/badge/?version=latest
+   :target: https://novelwriter.readthedocs.io/en/latest/?badge=latest
+   :alt: Documentation
+
+.. 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 documents. The idea is to have a simple text
+editor which allows for easy organisation of text documents 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 single project XML file. Other
+meta data is primarily saved as JSON files.
+
+Any operating system that can run Python 3 and has the Qt 5 libraries should be able to run
+novelWriter. It runs fine on Linux, Windows and macOS, and users have tested it on other platforms
+too. novelWriter can be run directly from the Python source, or installed from the pip tool or via
+the provided setup script. See :ref:`a_started`, or one or the setup instructions for your
+operating system for further details.
+
+**Useful Links**
+
+* Website: https://novelwriter.io
+* Documentation: https://novelwriter.readthedocs.io
+* 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
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Introduction
+
+   int_introduction
+   int_started
+   setup_linux
+   setup_mac
+   setup_windows
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Usage
+
+   usage_interface
+   usage_projects
+   usage_structure
+   usage_notes
+   usage_export
+   usage_typography
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Under the Hood
+
+   tech_technical
+
+
+Indices and Tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/index.txt

@@ -1,25 +0,0 @@
-####################################
-Welcome to novelWriter Documentation
-####################################
-
-This is the documentation for novelWriter |version|.
-
-**Contents**
-
-.. toctree::
-   :maxdepth: 2
-
-   introduction
-   started
-   interface
-   projects
-   structure
-   notes
-   export
-   technical
-
-**Indices and Tables**
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/source/int_introduction.rst

@@ -0,0 +1,131 @@
+.. _a_intro:
+
+************
+Introduction
+************
+
+novelWriter is a simple, multi-document plain text editor using a modified markdown syntax to apply
+simple formatting to the text. 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 in :ref:`a_struct`.
+
+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 referred to as "root" folders, and each entry can be tagged and cross-referenced from
+within the novel documents and notes. These tags make it possible to inter-link documents, and
+generate an overview of the entire novel project and how the various documents and plot elements
+are interconnected. The tag and reference syntax is covered in :ref:`a_proj` and :ref:`a_notes`.
+
+These additional features are not standard in markdown, but are available through special meta
+keywords described in :ref:`a_struct_tags`. Syntax highlighting is provided to make it easier to
+verify that the markdown tags are used correctly.
+
+An overview of the supported markdown syntax is covered in :ref:`a_ui`.
+
+
+.. _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 structures and objects often needed for such documents.
+   Formatting is limited to headers, and bold, italicised and strikethrough text.
+
+.. tip::
+   If you do need to align information in rows and columns in your notes, you can achieve this with
+   tabs and hard line breaks. The tab stop width can be specified in :guilabel:`Preferences` and
+   hard line breaks can be inserted by adding to spaces at the end of the line.
+
+The main window does not have a toolbar like many 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 so you don't have to look up the syntax every time until you've
+memorised it. A full list of shortcuts can be found in the :ref:`a_ui_shortcuts` section.
+
+In addition, novelWriter has 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,
+other light and dark themes are 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 Typicons_ icon set designed by Stephen Hutchings.
+
+The main window is split in two, or optionally three, panels. The left-most panel contains the
+project tree and all the documents in your project. The second panel is the document editor, and
+the optional third panel is a document viewer which can view any document in your project
+independently of the document editor. It is not intended as a preview window, although you can use
+it for this, but for viewing your notes next to your editor while you're writing.
+
+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 documents, this outline can be quite different from your project tree.
+Your project tree lists individual documents, your Outline tree lists the structure of the novel
+itself in terms of partitions, chapters and scenes as it appears in the text of the documents.
+
+.. _Typicons: https://github.com/stephenhutchings/typicons.font
+
+
+.. _a_intro_project:
+
+Project Layout
+==============
+
+You are free to organise your project documents as you wish into subfolders, and split the text
+between documents in whatever way suits you. All that matters to novelWriter is the linear order
+the documents appear at in the project tree (top to bottom). The chapters, scenes and sections of
+the novel are determined by the headings within those documents.
+
+The four heading levels (**H1** to **H4**) are treated as follows:
+
+* **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 documents. For the project notes,
+the header levels have no structural meaning, and the user is free to do whatever they want. See
+:ref:`a_struct` and :ref:`a_notes` for more details.
+
+
+.. _a_intro_export:
+
+Project Export
+==============
+
+The project can at any time be exported to a range of different formats through the
+:guilabel:`Build Novel Project` tool. Natively, novelWriter supports export to Open Document,
+HTML5, and various flavours of Markdown.
+
+The HTML5 export format is suitable for conversion by a number of other tools like Pandoc, or for
+importing into word processors if the Open Document format isn't suitable. In addition, printing
+and printing to PDF is also possible. 
+
+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 :ref:`a_export` for more details on export features and formats.
+
+
+.. _a_intro_screenshots:
+
+Screenshots
+===========
+
+**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/int_started.rst

@@ -0,0 +1,170 @@
+.. _a_started:
+
+***************
+Getting Started
+***************
+
+.. _main website: https://novelwriter.io
+.. _GitHub: https://github.com/vkbo/novelWriter/releases
+.. _PyPi: https://pypi.org/project/novelWriter/
+
+This section contains brief guides 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 the developer. No installers are provided at this
+time, but it is fairly straightforward to set up novelWriter with the provided install scripts.
+
+As novelWriter matures, more options for how to install it and get it running will be added. For
+non-Windows users the install process is at the present time best suited for people used to working
+with the command line. But even if you're not, the install process is fairly straightforward.
+
+The next pages have specific install instructions for the various operating systems novelWriter can
+run on. The instructions below are supplementary information, instructions for alterbative methods,
+and additional build options.
+
+.. note::
+   The text below assumes the command ``python`` corresponds to a Python 3 executable. Python 2 is
+   now deprecated, but many systems still have both Python 2 and 3. For such systems, the command
+   ``python3`` may be needed instead. On Linux, the scripts can also be made executable and run
+   without the ``python`` command. Likewise, ``pip`` may need to be replaced with ``pip3``.
+
+
+.. _a_started_depend:
+
+Dependencies
+============
+
+novelWriter has been designed to rely on as few dependencies as possible. Aside from the packages
+needed to communicate with the Qt GUI libraries, only one package is required for handling the XML
+format of the main project file. Everything else is handled with standard Python libraries.
+
+The following Python packages are needed to run novelWriter:
+
+* ``pyqt5`` – needed for connecting with the Qt5 libraries.
+* ``lxml`` – needed for full XML support.
+* ``pyenchant`` – needed for efficient spell checking (optional).
+
+PyQt/Qt should be at least 5.3, but ideally 5.10 or higher for nearly all features to work. For
+instance, searching using regular expressions with full Unicode support requires 5.13. There is no
+known minimum version requirement for package ``lxml``, but the code was originally written with
+4.2, which is therefore set as the minimum. It may work on lower versions. You have to test it.
+
+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 slower and less
+sophisticated spell checker than the full spell checking libaries. The spell check library must be
+at least 3.0 to work with Windows. On Linux, 2.0 also works fine.
+
+If you install from PyPi, these dependencies should be installed automatically. If you install from
+source, dependencies can still be installed from PyPi with:
+
+.. code-block:: console
+
+   pip install -r requirements.txt
+
+
+.. _a_started_install:
+
+Installing via PyPi
+===================
+
+The application is written in Python 3 using Qt5 via PyQt5. It is developed on Linux, but it should
+in principle work fine on other operating systems as long as dependencies are met.
+
+You can download the latest version of novelWriter from the source repository on GitHub_.
+novelWriter is also hosted on PyPi_, and can be installed on all operating systems that support Qt5
+and Python 3. It is regularly tested on Linux, Windows and macOS. The latest version of novelWriter
+is |release|.
+
+To install from PyPi you must first have the ``python`` and ``pip`` commands available on your
+system. If you don't, see specific instructions for your operating system in this documentation.
+To install novelWriter from PyPi, use the following command:
+
+.. code-block:: console
+
+   pip install novelwriter
+
+To upgrade an existing installation, use:
+
+.. code-block:: console
+
+   pip install --upgrade novelwriter
+
+When installing via pip, novelWriter can be launched from command line with:
+
+.. code-block:: console
+
+   novelWriter
+
+Make sure the install location for pip is in your PATH variable. This is not always the case by
+default.
+
+
+.. _a_started_i18n:
+
+Building the Translation Files
+==============================
+
+If you installed novelWriter from a package, the translation files should be pre-built and
+included. If you're running novelWriter from the source code, you will need to generate the files
+yourself. The files you need will be written to the ``nw/assets/i18n`` folder, and will have the
+``.qm`` file extension.
+
+You can build the ``.qm`` files with:
+
+.. code-block:: console
+
+   python3 setup.py qtlrelease
+
+This requires that the Qt Linguist tool is installed on your system. On Ubuntu and Debian, the
+needed package is called `qttools5-dev-tools`.
+
+.. note::
+   If you want to improve novelWriter with translation files for another language, or update an
+   existing translation, instructions for how to contribute can be found in the README file in the
+   ``i18n`` folder of the source code.
+
+
+.. _a_started_docs:
+
+Building the Documentation
+==========================
+
+If you installed novelWriter from a package, the documentation should be bre-built and 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-sphinx-rtd-theme``
+* ``python3-sphinxcontrib.qthelp``
+
+Or from PyPi:
+
+.. code-block:: console
+
+   pip install sphinx sphinx-rtd-theme sphinxcontrib-qthelp
+
+The documentation can then be built from the ``docs`` folder in the source code by running:
+
+.. code-block:: console
+
+   make html
+
+If successful, the documentation should be available in the ``docs/build/html`` folder and you can
+open the ``index.html`` file in your browser.
+
+The documentation can also be built for the Qt Assistant. To build the help packages from the
+documentation source, run the following from the root source folder:
+
+.. code-block:: console
+
+   python setup.py qthelp
+
+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.

docs/source/interface.txt

@@ -1,111 +0,0 @@
-***************
-User Interface
-***************
-
-The user interface is kept as simple as possible to avoid distractions when writing.
-The main window contains a tree view pane with the entire structure of the project, and a small details panel below it to display additional information about the currently selected item.
-
-Editing a document can be done by either double-clicking on it, or hitting the return key when a file is selected.
-This will open the document editor, which uses a simplified markdown format, described in the section below.
-
-The document currently being edited can also be viewed in parallel in a right hand side view pane.
-To view a document, simply press :kbd:`Ctrl-R`, or select a file and go to :menuselection:`Document --> View Document` in the menu.
-The document viewed does not need to be the same document currently being edited.
-
-References to tags can also be opened in the view pane from the document editor by moving the cursor to a reference to a tag and hitting :kbd:`Ctrl-Enter`.
-In the view panel, the references become clickable links, and the "Referenced By" panel at the bottom will show links to all documents referring back to it.
-
-.. note::
-   The "Referenced By" panel relies on an up-to-date index of the project.
-   If anything is missing, or seems wrong, the index can always be rebuilt from :menuselection:`Tools --> Rebuild Index` or by pressing :kbd:`F9`.
-
-Markdown Format
-===============
-
-The document editor uses a simplified markdown format.
-That is, it supports basic formatting like bold, italics and underline, as well as four levels of headings.
-The formats are listed below.
-
-In addition to these standard markdown features, the editor also allows for comments, that is text that is ignored by the word counter and not exported or, optionally, hidden in the document viewer.
-The editor also has a minimal set of keywords used for setting tags and references between files.
-
-.. csv-table:: Formatting Syntax
-   :header: "Format", "Description"
-   :widths: 15, 50
-
-   "``# Title``",         "Heading level one. The space after the # is mandatory."
-   "``## Title``",        "Heading level two. The space after the # is mandatory."
-   "``### Title``",       "Heading level three. The space after the # is mandatory."
-   "``#### Title``",      "Heading level four. The space after the # is mandatory."
-   "``**text**``",        "The text is renderred as bold text."
-   "``_text_``",          "The text is renderred as italics text."
-   "``__text__``",        "The text is renderred as underlined text."
-   "``% text...``",       "A comment. The text is not exported, seen in viewer, or counted towards word counts."
-   "``@keyword: value``", "A keyword argument followed by a value, or a comma separated list of values."
-
-The editor and viewer also supports markdown standard hard line breaks, and preserves non-breaking spaces.
-A hard line break is achieved by leaving two or more spaces at the end of the line.
-Alternatively, the user can press :kbd:`Shift-Enter` to insert this.
-A non-breaking space is inserted with :kbd:`Shift-Space`.
-
-Both hard line breaks and non-breaking spaces are highlighted by the syntax highlighter as an alternate coloured background, depending on the selected theme.
-
-Keyboard Shortcuts
-==================
-
-All features are available as keyboard shortcuts.
-These are as following:
-
-.. csv-table:: Keyboard Shortcuts
-   :header: "Shortcut", "Description"
-   :widths: 15, 50
-
-   ":kbd:`Ctrl-.`",          "Correct word under cursor."
-   ":kbd:`Ctrl-1`",          "Switch focus to tree view pane."
-   ":kbd:`Ctrl-2`",          "Switch focus to document editor pane."
-   ":kbd:`Ctrl-3`",          "Switch focus to document viewer pane."
-   ":kbd:`Ctrl-A`",          "Select all text in document."
-   ":kbd:`Ctrl-B`",          "Format selected text, or word under cursor, as bold."
-   ":kbd:`Ctrl-C`",          "Copy selected text to clipboard."
-   ":kbd:`Ctrl-D`",          "Wrap selected text, or word under cursor, in double quotes."
-   ":kbd:`Ctrl-E`",          "If in tree view, edit a document or folder settings."
-   ":kbd:`Ctrl-F`",          "Open the search bar and search for selected word, if any is selected."
-   ":kbd:`Ctrl-H`",          "Open the search and replace bar and search for selected word, if any is selected."
-   ":kbd:`Ctrl-I`",          "Format selected text, or word under cursor, as italic."
-   ":kbd:`Ctrl-N`",          "Create new document."
-   ":kbd:`Ctrl-O`",          "Open selected document."
-   ":kbd:`Ctrl-Q`",          "Exit novelWriter."
-   ":kbd:`Ctrl-R`",          "If in tree view, open a document for viewing. If in editor pane, open current document for viewing."
-   ":kbd:`Ctrl-S`",          "Save the current document in the editor."
-   ":kbd:`Ctrl-T`",          "Show project timeline."
-   ":kbd:`Ctrl-U`",          "Format selected text, or word under cursor, as underline."
-   ":kbd:`Ctrl-V`",          "Paste text from clipboard to cursor position."
-   ":kbd:`Ctrl-W`",          "Close the current document in the editor."
-   ":kbd:`Ctrl-X`",          "Cut selected text to clipboard."
-   ":kbd:`Ctrl-Y`",          "Redo latest undo."
-   ":kbd:`Ctrl-Z`",          "Undo latest changes."
-   ":kbd:`Ctrl-F7`",         "Toggle spell checking."
-   ":kbd:`Ctrl-Del`",        "If in tree view, move a document to trash, or delete a folder."
-   ":kbd:`Ctrl-Enter`",      "Open the tag or reference under the cursor in the view panel."
-   ":kbd:`Ctrl-Shift-,`",    "Change project settings."
-   ":kbd:`Ctrl-Shift-1`",    "Replace occurrence of word in current document, and search for next occurrence."
-   ":kbd:`Ctrl-Shift-A`",    "Select all text in current paragraph."
-   ":kbd:`Ctrl-Shift-D`",    "Wrap selected text, or word under cursor, in single quotes."
-   ":kbd:`Ctrl-Shift-I`",    "Import text to the current document from a text file."
-   ":kbd:`Ctrl-Shift-N`",    "Create new folder."
-   ":kbd:`Ctrl-Shift-O`",    "Open a project."
-   ":kbd:`Ctrl-Shift-R`",    "Close the document view pane."
-   ":kbd:`Ctrl-Shift-S`",    "Save the current project."
-   ":kbd:`Ctrl-Shift-W`",    "Close the current project."
-   ":kbd:`Ctrl-Shift-Up`",   "Move item one step up in the tree view."
-   ":kbd:`Ctrl-Shift-Down`", "Move item one step down in the tree view."
-   ":kbd:`F1`",              "Open documentation."
-   ":kbd:`F2`",              "Alternative to :kbd:`Ctrl-E`."
-   ":kbd:`F3`",              "Find next occurrence of word in current document."
-   ":kbd:`F5`",              "Export project dialog."
-   ":kbd:`F7`",              "Re-run spell checker."
-   ":kbd:`F9`",              "Re-build project indices."
-   ":kbd:`Shift-Enter`",     "Insert a hard line break at the cursor position."
-   ":kbd:`Shift-F3`",        "Find previous occurrence of word in current document."
-   ":kbd:`Shift-Space`",     "Insert a non-breaking space at the cursor position."
-   ":kbd:`Enter`",           "If in tree view, open a document for editing."

docs/source/introduction.txt

@@ -1,49 +0,0 @@
-************
-Introduction
-************
-
-novelWriter is a simple, multi-document plain text editor using a modified markdown syntax to apply simple formatting.
-Additional features that are not standard markdown are available through special meta data keywords.
-These keywords make it possible to inter-link documents, and generate an overview of the entire novel project and how the various files are interconnected.
-
-Design Philosophy
------------------
-
-The user interface 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 its formatting is limited to headers, and bold, italics and underlined text.
-
-Most features are accessible through the menu and through keyboard shortcuts.
-The colour scheme of the user interface can be modified with various themes, and new themes are fairly straight forward to add.
-
-The project itself is laid out in a tree view on the left hand side of the main window.
-It has various sections, called *root folders*, for the various types of supporting files that the user may want to add to the project.
-The novel itself lives under its own root folder.
-
-Project Layout
---------------
-
-The layout of the novel itself is managed through the four supported heading levels, H1 through H4.
-H1 is used for the book title, and for partitions.
-H2 is used for chapter tiles.
-H3 is reserved for scene titles.
-H4 is for section titles within scenes, if such granularity is necessary.
-
-For the files designated as project notes, the usage of headers imply no structural meaning, and the user is free to do whatever they want.
-
-Project Export
---------------
-
-The project can at any time be exported to a range of different formats.
-Natively, novelWriter supports export to plain text file, html5 document, LaTeX source file, novelWriter flavoured markdown, and standard markdown.
-Additional export options are available through `Pandoc <https://pandoc.org/>`_.
-Currently, novelWriter will assist in converting the project to Open Office documents, Word documents, and epub.
-However, to be able to fully take advantage of the many features of Pandoc, you may want to run it yourself and use the novelWriter html or markdown export as input.
-
-screenshot
-----------
-
-.. image:: images/screenshot.png
-   :width: 800

docs/source/notes.txt

@@ -1,23 +0,0 @@
-************************
-Supporting Files (Notes)
-************************
-
-Supporting files, or notes, are any files stored in root folders that are not the Novel root folder.
-These files are intended for summaries and outlines of the various plot elements, characters, locations, and so on, of the novel.
-These are not required, but making at least minimal files for each such element, and add a tag to them, makes it possible to use the timeline view feature to see how each element intersects with each section of the novel itself.
-
-File Tags
-=========
-
-Each 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 and will then show up as dots in the timeline view.
-
-The syntax highlighter will alert the user that the keyword is correctly used and that the tag is allowed.
-Duplicate tags should be detected as long as the index is up to date.
-
-The tag is the only part of these files that the application uses.
-The rest of the file is there for the writer to use in whatever way they wish.
-
-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 pane, these become clickable links, making it easier to follow connections in the plot.

docs/source/projects.txt

@@ -1,130 +0,0 @@
-**************
-Novel Projects
-**************
-
-A novelWriter project requires a dedicated folder for storing its files on the local file system.
-See the Technical Information section for further details.
-
-A new project can be created from the Project menu by selecting :menuselection:`Project --> New Project`.
-A list of recently opened projects is also maintained and can be selected from the menu.
-
-The project specific settings are available in :menuselection:`Project --> Project Settings`.
-See further details below.
-
-Project Structure
-=================
-
-Projects are structured into a set of root folders, visible in the left side tree view panel.
-
-The core novel files go into a root folder of type "Novel".
-Other supporting files go into root folders of types "Plot", "Characters", "Locations", "Timeline", "Objects", "Entities" or "Custom".
-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 :menuselection:`Project --> Create Root Folder`.
-
-The root folders are intended for the follwing use, but aside from the Novel folder, not restrictions apply.
-
-* **Novel:** 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 Novel Structure section for more details.
-* **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 generate the timeline view.
-* **Characters:** Character files go in this root folder.
-  These are especially important if one wants to use the timeline view to see which character appears where and which part of the story is told from a specific character's point-of-view.
-* **Locations:** Location is for various scene locations that one wants to track in the timeline view if that applies to the story.
-* **Timeline:** If the story jumps in time within the same plot, this class of files can be used to track this.
-* **Objects:** Important objects in the story can be tracked here.
-* **Entities:** Entities, like organisations or companies, that are part of the plot, can be organised here.
-* **Custom:** The custom root folder can be used for tracking anything else not covered by the above options.
-
-Deleted files will be moved into a special "Trash" root folder.
-Currently, these files cannot be permanently deleted from the project.
-
-Orphaned Documents
-------------------
-
-In the event the editor crashes or otherwise exits without saving the project state, files that have been added to the project tree and are saved to disk will appear in a special "Orphaned Items" root folder next time the application is started.
-These orphaned files will not have any meta data associated with them, so the label and other information has to be set again, and the files moved back to the correct location in the project.
-
-Using Folders in the Project Tree
----------------------------------
-
-Folders, aside from root folders, have no structural significance to the project.
-They are there purely as a way for the user to organise the files in meaningful sections and to be able to close them in the tree view.
-When processing the files in the novel, like for instance during export, the folders are ignored.
-
-Project Settings
-================
-
-The project settings can be accessed from the :menuselection:`Project --> Project Settings` menu entry.
-This will open a dialog box, with a set of tabs.
-
-Settings Tab
-------------
-
-The Settings tab holds the project title and author settings.
-Working Title can be set to a different title than the Book Title.
-The difference between them is simply that the Working Title is used for the GUI (main window title) and for generating the backup files.
-The intention is that the working title should remain unchanged, while changing the final title has no effect on features relying on the project name.
-The Book Title is currently not ues for anything, so setting it is just for the benefit of the author.
-
-The Book Authors text box takes one author per line.
-
-Status Tab
-----------
-
-Each file of type "Novel" can be given a status level, signified by a coloured icon.
-These are purely there for the user's convenience, and you are not required to use them for any other feature to work.
-The intention is to use this list to set what stage of writing you are on, although you can in principle make them whatever you want.
-
-.. note::
-   The status levels currently in use by a file cannot be deleted.
-
-Importance Tab
---------------
-
-Each file of types "Plot", "Character", "World", "Timeline", "Object", "Entity", or "Custom", can be given an importance level, signified by a coloured icon like for status level.
-These are also purely there for the user's convenience, and you are not required to use them for any other feature to work.
-The intention is to use this list to set how important the character, plot element, or otherwise, is for the story.
-Again, these can in principle be used for whatever you want.
-
-.. note::
-   The importance levels currently in use by a file cannot be deleted.
-
-Auto-Replace Tab
-----------------
-
-A set of automatically replaced keywords can be added in this tab.
-The keywords in the left column wile be replaced by the text in the right column when documents are opened in the viewer.
-This will also be applied to exports when the feature is added.
-
-Note that 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.
-
-Writing Files
-=============
-
-New document files can be created from the Document menu, or by pressing :kbd:`Ctrl-N` while in the tree view pane.
-This will create a new, empty file, and open the item settings dialog where the filename and various other settings can be set.
-This dialog can also be opened again later from either the menu, :menuselection:`Project -> Edit` item, or by pressing :kbd:`Ctrl-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 the Project Structure section for more details.
-
-Backup
-======
-
-An automatic backup system is built into novelWriter.
-In order to use it, a backup path to where the backups are to be stored needs to be provided in :menuselection:`Tools --> 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.
-
-The backup feature, when configured, can also be run manually from the Tools menu.
-
-For the backup to be able to run, the Working Title must be set in Project Settings.
-This value is used to generate the file name.
-It is also possible to dissable automated backup for a given project in its project settings.

docs/source/requirements.txt

@@ -0,0 +1 @@
+sphinx_rtd_theme

docs/source/setup_linux.rst

@@ -0,0 +1,110 @@
+.. _a_setup_linux:
+
+**************
+Setup on Linux
+**************
+
+.. _GitHub: https://github.com/vkbo/novelWriter/releases
+.. _main website: https://novelwriter.io
+
+This is a brief guide to how you can get novelWriter running on a Linux computer. There are
+currently no install package of novelWriter for Linux, so it is recommended that you download
+either the full source or minimal package and extract it to a practical location on your system and
+run the ``setup.py`` script.
+
+
+Running from Source
+===================
+
+To run novelWriter from source, download the latest source package from the release page on
+GitHub_ or the `main website`_, or if you have git running on your computer, you can also clone the
+repository.
+
+
+Step 1: Installing Dependencies
+-------------------------------
+
+The dependencies of novelWriter are generally available from Linux distro repositories. For Debian
+and Ubuntu, they can be installed with:
+
+.. code-block:: console
+
+   sudo apt install python3-pyqt5 python3-lxml python3-enchant
+
+If you prefer to install dependencies via PyPi, or the repository dependencies are out of date, you
+can install them with:
+
+.. code-block:: console
+
+   pip3 install --user -r requirements.txt
+
+
+Step 2: Install Package (Optional)
+----------------------------------
+
+You can install novelWriter to the default location for Python packages using ``setuptools``. This
+step is optional as you can also just put the novelWriter program folder wherever you like
+yourself. For instance in ``/opt/novelWriter``, and then run Step 3 to set up icons and launcher.
+
+To install novelWriter to the default location, it requires that you have ``setuptools`` installed
+on your system. If you don't have it installed, it can usually be installed from your distro's
+repository. For Debian and Ubuntu this is achieved with:
+
+.. code-block:: console
+
+   sudo apt install python3-setuptools
+
+The package is also available from PyPi:
+
+.. code-block:: console
+
+   pip3 install --user setuptools
+
+With ``setuptools`` in place, novelWriter can be installed to the user space with:
+
+.. code-block:: console
+
+   ./setup.py install --user
+
+This should install novelWriter as ``~/.local/bin/novelWriter``. If you instead want to install for
+all users, i.e. as ``/usr/local/bin/novelWriter``, run:
+
+.. code-block:: console
+
+   sudo ./setup.py install
+
+This is equivalent to what the ``pip`` installer does. It puts novelWriter in the location on your
+system where Python packages are usually kept. This is not really the best suited location for a
+GUI application like novelWriter, so you may instead copy the entire source to a suiteable location
+yourself.
+
+
+Step 3: Create Launcher Icons
+-----------------------------
+
+Regardless of where you extract or install the source files, you can set up a standard icon and a
+launcher. To set up this desktop launcher, the needed icons, and the project file association,
+run the following from inside the novelWriter folder at the installed or final location:
+
+.. code-block:: console
+
+   ./setup.py xdg-install
+
+By default, this command installs the launcher and icons for the current user only. To install for
+all users, run the script with the ``sudo`` command.
+
+.. tip::
+   All options of the setup script can be listed with: ``./setup.py help``.
+
+
+Uninstalling Icons
+==================
+
+The steps taken by the ``xdg-install`` step can be reversed by running:
+
+.. code-block:: console
+
+   ./setup.py xdg-uninstall
+
+This will remove the desktop launcher and icons from the system. As above, whether this is done on
+the current user, or system wide, depends on whether this command is called with ``sudo`` or not.

docs/source/setup_mac.rst

@@ -0,0 +1,74 @@
+.. _a_setup_mac:
+
+**************
+Setup on macOS
+**************
+
+.. _GitHub: https://github.com/vkbo/novelWriter/releases
+.. _main website: https://novelwriter.io
+.. _brew docs: https://docs.brew.sh/Homebrew-and-Python
+
+This is a brief guide to how you can get novelWriter running on macOS. There are currently no
+install package of novelWriter for macOS, so it is recommended that you download either the full
+source or minimal package and extract it to a practical location on your system and
+run it.
+
+
+Running from Source
+===================
+
+To run novelWriter from source, download the latest source package from the release page on
+GitHub_ or the `main website`_, or if you have git running on your computer, you can also clone the
+repository.
+
+
+Step 1: Installing Dependencies
+-------------------------------
+
+These instructions assume you're using brew, and have Python and pip set up. If not, see the
+`brew docs`_ for help. Main requirements are installed via the requirements file. You also need to
+install the ``pyobjc`` package, so you should run:
+
+.. code-block:: console
+
+   pip3 install --user -r requirements.txt
+   pip3 install --user pyobjc
+
+For spell checking you may also need to install the enchant package. It comes with a lot of default
+dictionaries.
+
+.. code-block:: console
+
+   brew install enchant
+
+With the dependencies in place, you can launch the ``novelWriter.py`` script directly to run
+novelWriter.
+
+
+Step 2: Install Package (Optional)
+----------------------------------
+
+You can install novelWriter to the correct location for Python packages with:
+
+.. code-block:: console
+
+   ./setup.py install --user
+
+This requires that the package ``setuptools`` is installed on your system. If not, it can be
+installed with:
+
+.. code-block:: console
+
+   pip3 install --user setuptools
+
+This is method of install is equivalent to what the ``pip`` installer does. It puts novelWriter in
+the location on your system where Python packages are usually kept. This is not really the best
+suited location for a GUI application like novelWriter, so you may instead copy the entire source
+to a suiteable location yourself.
+
+After this, you should be able to launch novelWriter by running ``novelWriter`` in a command line
+window.
+
+.. note::
+   Right now there isn't a better integration with macOS available. Contributions from someone more
+   familiar with macOS would be very much appreciated.

docs/source/setup_windows.rst

@@ -0,0 +1,149 @@
+.. _a_setup_win:
+
+****************
+Setup on Windows
+****************
+
+This is a brief guide to how you can get novelWriter running on a Windows computer.
+
+Unlike other operating systems, Windows does not come prepared with an environment to run Python
+applications, so you must first install Python. After that, running novelWriter is straightforward.
+
+.. tip::
+   If you have any problems, you can always open a question on the project's discussions_ page.
+   This requires a GitHub account.
+
+.. _discussions: https://github.com/vkbo/novelWriter/discussions
+
+
+.. _a_setup_win_installer:
+
+Using the Installer
+===================
+
+The installer for Windows is no longer provided. See the `installer issue`_ for more info on why.
+You can still create the installer yourself if you want to. It can be generated with the provided
+``setup.py`` script. use the script's ``help`` command to get further instructions.
+
+Please use the "Running from Source" option below instead. It has been improved and a script has
+been added that does nearly the same thing.
+
+.. _installer issue: https://github.com/vkbo/novelWriter/issues/640
+
+
+.. _a_setup_win_source:
+
+Running from Source
+===================
+
+To run novelWriter from source, download the latest source zip file from the release page on
+GitHub_, or from the `main website`_. You can download the "Minimal Windows" zip file. It is a
+minimal version of the source that contains only the files needed for running on Windows. You can
+also download the full source if you wish.
+
+In order to make novelWriter run on your system, you must first have Python installed (Step 1).
+Thereafter, a script will do the rest of the job (Step 2). Alternatively, you can run this step
+manually from the command prompt if you wish to.
+
+.. tip::
+   If your system already has all the dependencies installed, you can run novelWriter directly from
+   the extracted folder by double-clicking the ``novelWriter.pyw`` file. However, running the
+   script also adds start icons.
+
+.. _GitHub: https://github.com/vkbo/novelWriter/releases
+.. _main website: https://novelwriter.io
+
+
+Step 1: Installing Python
+-------------------------
+
+If you already have Python installed, you can skip this step. If you don't have it installed, you
+can download it from the python.org_ website. novelWriter should work with Python 3.6 or higher,
+but it is recommended that you install the latest version of Python.
+
+Make sure you select the "Add Python to PATH" option during installation, otherwise the ``python``
+command will not work in the command line window.
+
+.. image:: images/python_win_install.png
+   :width: 600
+
+.. _python.org: https://www.python.org/downloads/windows
+
+
+Step 2: Dependencies and Icons
+------------------------------
+
+**Alternative A: By Script**
+
+Open the folder where you extracted novelWriter, and double-click the file named
+``windows_install.bat``. This should open a command line window and run the setup script to install
+dependencies, and add desktop and start menu icons.
+
+.. note::
+   If you downloaded the full source package, the file may be in the ``setup`` subfolder.
+
+The script will also check that it can find Python on your system and alert you if it cannot run
+it. If you are sure you have installed it, but the script cannot find it, you probably didn't
+install it with the "Add Python to PATH" option mentioned in Step 1.
+
+.. note::
+   If you upgrade Python to a newer version and the path to ``pythonw.exe`` has therefore changed,
+   you may need to run this script again. You can also run it to upgrade dependencies to the latest
+   version.
+
+**Alternative B: Manual Installation**
+
+The above alternative can also be run manually.
+
+Open the windows command prompt. It can be launched by pressing the :kbd:`Win` key and typing "cmd".
+The "Command Prompt" app should then be in the list of applications.
+
+With the command prompt open, navigate to the folder where you extracted the novelWriter source,
+and run the following commands:
+
+.. code-block:: console
+
+   pip install --user pywin32 -r requirements.txt
+   python setup.py win-install
+
+The first command will install the dependencies on your system from the `Python Package Index`_,
+and the second command will create a desktop icon and a start menu icon. That should be all that
+you need.
+
+.. _Python Package Index: https://pypi.org/
+
+
+Uninstalling
+============
+
+**Alternative A: By Script**
+
+Open the folder where you keep the novelWriter files, and double-click the file named
+``windows_uninstall.bat``. This should open a command line window and run the setup script to
+remove the main dependency packages and remove desktop and start menu icons.
+
+.. note::
+   If you downloaded the full source package, the file may be in the ``setup`` subfolder.
+
+If you plan to also remove Python from your system, you must run the above script first as it needs
+Python in order to run.
+
+.. note::
+   Due to limitations of the ``pip`` installer, dependencies of the dependencies will not be
+   removed, only the ones the setup script directly installed.
+
+**Alternative B: Manual Uninstallation**
+
+Like for the install process, the script just runs two commands. You can of course run them
+yourself if you wish. They are:
+
+.. code-block:: console
+
+   python setup.py win-uninstall
+   pip uninstall -r requirements.txt
+
+There may be other packages on your system installed by ``pip``. To list all packages, run:
+
+.. code-block:: console
+
+   pip freeze --user

docs/source/started.txt

@@ -1,88 +0,0 @@
-***************
-Getting Started
-***************
-
-You can download novelWriter from https://github.com/vkbo/novelWriter/releases
-
-Latest version is |version|:
-
-* ZIP file: https://github.com/vkbo/novelWriter/archive/v0.3.2.zip
-* TAR file: https://github.com/vkbo/novelWriter/archive/v0.3.2.tar.gz
-
-Extract the archive to a location of your choice.
-
-Installing Dependencies
-=======================
-
-If you already have Python installed, all you need to do is install the dependencies.
-To do this, your need to open your command line tool, find the folder where you extracted novelWriter, and run:
-
-.. code-block:: console
-
-   python -m pip install -r requirements.txt
-
-On some operating systems you need to use ``python3`` instead of ``python``.
-
-The following Python packages are required to run novelWriter:
-
-* ``pyqt5`` for the GUI
-* ``appdirs`` for locating the system's config folder
-* ``lxml`` for writing project files
-
-.. note::
-   Sometimes the SVG graphics package for pyqt5 must be installed separately.
-
-The following are optional, but recommended:
-
-* ``pyenchant`` for spell checking
-* ``pycountry`` for translating language codes to language names
-* ``latexcodec`` for escaping unicode characters in LaTeX export
-* ``pypandoc`` for additional exports to Word, Open Office, eBooks, etc.
-
-
-Running novelWriter
-===================
-
-If all the required dependencies are met, you can run novelWriter from the command line:
-
-.. code-block:: console
-
-   python 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
-
-
-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.
-
-
-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.5 or higher, and the executable installer is the easiest to install.
-Please note that the `pyenchant` package for spell checking does not currently work with the x86-64 version, so if you want spell checking, you must install the x86 version.
-
-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.txt

@@ -1,101 +0,0 @@
-*****************
-Project Structure
-*****************
-
-This section covers the structure of a novel project.
-
-.. note::
-   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.
-
-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.
-Four levels of headings are supported, signified by the number of hashes preceding the title.
-See the Markdown section.
-
-The header levels are not only important when generating the exported novel file, but is also used by the indexer and timeline view.
-Each heading starts a new region where new references to tags can be set, and will show up as a new row in the timeline view.
-
-The different header levels are interpreted as specific section types of the novel.
-
-* ``# Header1``: Header level 1 signifies that the text refers to either the novel title or the name of a top level partition.
-* ``## Header2``: Header level 2 signifies a chapter level partition.
-* ``### Header3``: Header level 3 signifies a scene level partition.
-* ``#### Header4``: Header level 4 signifies a sub-scene level partition.
-
-Tag References
-==============
-
-Each section, indicated by a heading, can contain references to tags set in the supporting files of the project.
-See the File Tags section.
-
-The references are gathered by the indexer and used to generate the timeline view of how the different parts of the novel are connected.
-References and tags are also clickable in the view panel, and makes it easy to navigate reference notes while writing.
-
-References are set as keyword and a list of corresponding tags.
-The valid keywords are listed below. The format of such a line is ``@keyword: value1, [value2] ... [valueN]``.
-Note that not all keywords allow multiple values.
-
-* ``@pov``: The point-of-view character for the current section.
-  The target must be a note tag in the character root folder.
-  Only one value is accepted. further values are ignored.
-* ``@char``: Other characters in the current section.
-  The target must be a note tag in the character root folder.
-  Multiple values are allowed.
-  This should not include the point-of-view character.
-* ``@plot``: The plot timelines touched by the current section.
-  The target must be a note tag in the plot root folder.
-  Multiple values are allowed.
-* ``@time``: The timelines touched by the current section.
-  The target must be a note tag in the timeline root folder.
-  Multiple values are allowed.
-* ``@location``: The location the current section takes place in.
-  The target must be a note tag in the locations root folder.
-  Multiple values are allowed.
-* ``@object``: Objects present in the current section.
-  The target must be a note tag in the object root folder.
-  Multiple values are allowed.
-* ``@entity``: Entities present in the current section.
-  The target must be a note tag in the entities root folder.
-  Multiple values are allowed.
-* ``@custom``: Custom references in the current section.
-  The target must be a note tag in the custom root folder.
-  Multiple values are allowed.
-
-The syntax highlighter will alert the user that only the correct keywords are used, and that the tags referenced exist.
-If the index of defined tags is out of date, press :kbd:`F9` to regenerate it, or select :menuselection:`Tools --> Rebuild Indices` from the menu.
-In general, the index for a file is regenerated when a file is saved, so this shouldn't normally be necessary.
-
-Novel File Layout
-=================
-
-Files that exist under the Novel type root folder can have a number of layouts set.
-See overview below.
-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 selected also shows up as flags in the tree view, making it easier to track what kind of files they are.
-
-* **Title Page**: The title page layout.
-  The title should be formatted as a heading level one.
-* **Book**: In principle, the entire novel can be contained in a single file.
-  In that case, use the Book layout on this file.
-  The internal structure is then controlled by the heading levels.
-* **Plain Page**: A plain page is just that,
-  It is not included into content and the heading levels are ignored.
-* **Partition**: A partition can be used to split a the novel into parts.
-  Use a level one heading for this.
-* **Chapter**: Signifies the start of a new chapter.
-  If the text itself is contained in scene files, these files should only contain the title and tag references for characters, plot, etc.
-  The heading for chapters should be level two.
-* **Unnumbered**: Same as Chapter, but when exporting the files and automatic chapter numbering is enabled, this file will not receive a number.
-* **Scene**: A scene file.
-  This file should have a header of level three.
-  Further sections can have headers of level four.
-  These will not impact the overall structure, but will allow for setting new characters and plot references in parts of a scene if such granularity is needed.
-* **Note**: A generic file that is optionally ignored when the novel is exported.
-
-The layout granularity is entirely optional.
-In principle, you can write the entire novel in a single file with layout "Book".
-You can also have a single file per chapter.

docs/source/tech_technical.rst

@@ -0,0 +1,145 @@
+.. _a_tech:
+
+*********************
+Technical Information
+*********************
+
+This section contains details of how novelWriter stores and handles the project data.
+
+
+How Project Data is Stored
+==========================
+
+All novelWriter files are written with utf-8 encoding. Since Python automatically converts Unix
+line endings to Windows line endings on Windows systems, novelWriter does not make any adaptations
+to the formatting on Windows systems. This is handled entirely by the Python standard library.
+Python also handles this fairly well when working on the same files on both Windows and Unix-based
+operating systems.
+
+
+Main Project File
+-----------------
+
+The project itself requires a dedicated folder for storing its files where novelWriter will create
+its own "file system" where the folder and file hierarchy is described in a project XML file. This
+is the main project file in the project's root folder with the name ``nwProject.nwx``. This file
+also contains all the meta data required for the project, and a number of related project settings.
+
+If this file is lost or corrupted, the structure of the project is lost, although not the text
+itself. It is important to keep this file backed up, either through the built-in backup tool, or
+your own backup solution.
+
+.. tip::
+   The novelWriter project folder is structured so that it can easily be added to a version control
+   system like git. If so, you may want to add a `.gitignore` file to exclude files with the
+   extensions `.json` as JSON files are used to cache the index and various run-time settings and
+   are generally large files that change often. You'd also want to exclude the ``cache`` folder.
+
+The project XML file is indent-formatted, suitable for diff tools and version control since most of
+the file will stay static, although a timesetamp is set in the meta section on line 2 each time the
+file is saved, and various meta data entries are incremented on each save.
+
+
+Project Documents
+-----------------
+
+All the project documents are saved in a folder in the main project folder named ``content``. Each
+document has a file handle taken from the first 13 characters of a SHA256 hash of the system time
+when the document was first created. The documents are saved with a filename assembled from this
+hash and the file extension ``.nwd``.
+
+If you wish to find the file system location of a document in the project, you can either look it
+up in the project XML file, select :guilabel:`Show File Details` from the :guilabel:`Document` menu
+when having the document open, or look in the ``ToC.txt`` file in the root of the project folder.
+The ``ToC.txt`` file has a list of all documents in the project, referenced by their label, and
+where they are saved.
+
+The reason for this cryptic file naming is to avoid issues with file naming conventions and
+restrictions on different operating systems, and also to have a file name that does not depend on
+what the user names the document within the project, or changes it to.
+
+Each document file contains a plain text version of the text from the editor. The file can in
+principle be edited in any text editor, and is suitable for diffing and version control if so
+desired. Just make sure the file remains in utf-8 encoding, otherwise unicode chatracters may
+become mangled when the file is opened in novelWriter again.
+
+The first lines of the file may contain some meta data starting with the characters ``%%~``. These
+lines are mainly there to restore some information if it is lost from the project file, and the
+information may be helpful if you do open the file in an external editor as it contains the
+document label and the document class and layout. The lines can be deleted without any consequences
+to the rest of the content of the file, and will be added back the next time the document is saved
+in novelWriter.
+
+
+The File Saving Process
+-----------------------
+
+When saving the project file, or any of the documents, the data is first saved to a temporary file.
+If successful, the old data file is removed, and the temporary file becomes the new file. This
+ensures that the previously saved data is only replaced when the new data has been successfully
+saved to the storage medium.
+
+For the project XML file, a ``.bak`` file is in addition kept, which will always contain the
+previous version of the file, although when auto-save is enabled, they may have the same content.
+If the opening of a project file fails, novelWriter will automatically try to open the ``.bak``
+file instead.
+
+
+Project Meta Data
+=================
+
+The project folder contains a subfolder named ``meta``, containing a number of files. The meta
+folder contains semi-important files. That is, they can be lost with only minor impact to the
+project.
+
+If you use version control software on your project, you can exclude this folder, although you may
+want to track the session log file. The JSON files within this folder can safely be ignored as they
+will be automatically regenerated if lost.
+
+
+The Project Index
+-----------------
+
+Between writing sessions, the project index is saved in a JSON file in ``meta/tagsIndex.json``.
+This file is not critical. If it is lost, it can be rebuilt from within novelWriter from the
+:guilabel:`Tools` menu.
+
+The index is maintained and updated whenever a document or note is saved in the editor. It contains
+all references and tags in documents and notes, as well as the location of all headers in the
+project, and the word counts within each header section.
+
+The integrity of the index is checked when the file is loaded. It is possible to corrupt the index
+if the file is manually edited and manipulated, so the check is important to avoid sudden crashes
+of novelWriter. if the file contains errors, novelWriter will automatically build it anew. If the
+check somehow fails and novelWriter keeps crashing, you can delete the file manually and rebuild
+the index. If this too fails, you have likely encountered a bug.
+
+
+Cached GUI Options
+------------------
+
+A file named ``meta/guiOptions.json`` contains the latest state of various GUI buttons, switches,
+dialog window sizes, column sizes, etc, from the GUI. These are the GUI settings that are specific
+to the project. Global GUI settings are stored in the main config file.
+
+The file is not critical, but if it is lost, all such GUI options will revert back to their default
+settings.
+
+
+Session Stats
+-------------
+
+The writing progress is saved in the ``meta/sessionStats.log`` file. This file records the length
+and word counts of each writing session on the given project. The file is used by the
+:guilabel:`Writing Statistics` tool. If this file is lost, the history it contains is also lost,
+but it has otherwise no impact on the project.
+
+
+Project Cache
+=============
+
+The project ``cache`` folder contains non-critical files. If these files are lost, there is no
+impact on the functionality of novelWriter or the history of the project. It contains temporary
+files, like the preview document in the :guilabel:`Build Novel Project` tool.
+
+It should be excluded from version control tools if such are used.

docs/source/technical.txt

@@ -1,41 +0,0 @@
-*********************
-Technical Information
-*********************
-
-This section contains details of how novelWriter stores and handles the project data.
-
-How Data is Stored
-==================
-
-All novelWriter files are written with utf-8 encoding.
-Since Python automatically converts Unix line endings to Windows line endings on Windows systems, novelWriter does not make any adaptations to the formatting on Windows systems.
-
-Main Project File
------------------
-
-The project itself requires a dedicated folder for storing its files.
-The main project file is stored as an XML file with the name ``nwProject.nwx``.
-This file contains all the meta data unique for the project.
-That includes project settings.
-
-If this file is lost or corrupted, the structure of the project is lost.
-It is important to keep this file backed up.
-The last 10 versions of the file are kept in backup in the project's ``cache`` folder.
-These files are replaced on a rotation from 0 to 9.
-
-The project XML file is suitable for diff tools and version control, although a timesetamp is set in the meta section on line 2 each time the file is saved.
-
-Project Documents
------------------
-
-The project documents are saved in folders staring with ``data_``.
-Each document has a file handle taken from the first 13 characters of a SHA256 hash of the system time when the file was first created.
-The documents are saved with a folder and filename derived from this hash.
-If you wish to find the physical location of a file in the project, you can either look it up in the project XML file, or select :menuselection:`Document --> Show File Details` in the menu when having the document open.
-
-The reason for this cryptic file naming is to avoid issues with file naming conventions and restrictions on different operating systems, and also to have a file name that does not depend on what the user names the files, or changes it to.
-The file name set in the tree view is only saved in the project XML file.
-
-Each document file contains a plain text version of the text from the editor.
-The file can in principle be edited in any text editor, and is suitable for diffing and version control if so desired.
-Just make sure the file remains in utf-8 encoding, otherwise unicode chatracters may become mangled.

docs/source/usage_export.rst

@@ -0,0 +1,157 @@
+.. _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 build tool. This is done through
+a series of keyword–replace steps. They are all on the format ``%keyword%``.
+
+``%title%``
+   This keyword will always be replaced with the title text you put after the ``#`` characters in
+   your document.
+
+``%ch%``
+   This will be replaced by a chapter number. The number is incremented by one each time the build
+   tool sees a new heading of level two in a document with layout :guilabel:`Chapter`. If the
+   document has layout :guilabel:`Unnumbered`, the counter is *not* incremented. The latter is
+   useful for for instance Prologue and Epilogue chapters. Adding an asterisk (``*``) in front of
+   the title text of a level two heading will also disable the chapter counter for that heading.
+
+``%chw%``
+   Behaves like ``%ch%``, but the number is represented as a number word.
+
+``%chi%``
+   Begaves like ``%ch%``, but the number is represented as a lower case Roman number.
+
+``%chI%``
+   Behaves 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%``
+   Behaves like ``%sc%``, but the number is *not* reset to 1 for each chapter. Instead it runs from
+   1 from the beginning of the novel to produce an absolute scene count.
+
+``\\``
+   This inserts a line break within the title.
+
+.. note::
+   Header formatting only applies to novel documents. Headings in notes will be left as-is 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.
+* The format ``Chapter %ch%: %title%`` produces something like "Chapter 1: My Chapter Title".
+* The format ``Scene %ch%.%sc%`` produces something like "Scene 1.2" for scene 2 in chapter 1.
+
+
+.. _a_export_scenes:
+
+Scene Separators
+================
+
+If you don't want any titles for your scenes (or for your sections if you have them), you can leave
+the formatting boxes empty. If so, an empty paragraph will be inserted between the scenes or
+sections instead.
+
+Alternatively, if you want a separator between them, like the common ``* * *``, you can enter the
+desired separator text in the formatting box. In fact, if the format is a piece of static text, it
+will always be treated as a separator.
+
+
+.. _a_export_files:
+
+File Selection
+==============
+
+Which documents and notes are selected for export can be controlled from the options on the left
+side of the dialog window. The switch for :guilabel:`Include novel files` will select any document
+that isn't classified as a note. The switch for :guilabel:`Include note files` will select any
+document that *is* a note. This 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 documents from your exports, like draft documents or documents you
+want to take out of your manuscript, but don't want to delete, you can un-check the
+:guilabel:`Include when building project` option for each document in the project tree. An included
+document 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_print:
+
+Printing
+========
+
+The print button allows you to print the content in the preview window. You can either print to one
+of your system's printers, or print directly to file. You can also print to file from the regular
+print dialog. The direct to file option is just a shortcut.
+
+
+.. _a_export_formats:
+
+Export Formats
+==============
+
+Currently, six formats are supported for exporting.
+
+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.
+
+novelWriter HTML
+   The HTML export format writes a single ``.htm`` file with minimal style formatting. The exported
+   HTML document is suitable for further processing by document conversion tools like Pandoc, for
+   importing in word processors, or for printing from browser.
+
+novelWriter Markdown
+   This is simply a concatenation of the project documents selected by the filters. The documents
+   are stacked together in the order they appear in the project tree, with comments, tags, etc.
+   included if they are selected. This is a useful format for exporting the project for later
+   import back into novelWriter.
+
+Standard/GitHub Markdown
+   The Markdown export format comes in both Standard and GitHub flavour. The *only* difference in
+   terms of novelWriter functionality is the support of strikethrough text, which is not supported
+   by the Standard flavour, but *is* supported by the GitHub flavour.
+
+
+.. _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. These 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
+document, in the order they appear in the project tree. Each document is then split up into a list
+as well, with one entry per paragraph it contains.
+
+These files are mainly intended for scripted post-processing for those who want that option. A JSON
+file can be imported directly into a Python dict object or a PHP array, to mentions a few options.

docs/source/usage_interface.rst

@@ -0,0 +1,537 @@
+.. _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
+   :guilabel:`Project` 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 document, or the sum of words of 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 document is included in the final project build or not.
+   You may want to filter out documents 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 document. 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
+   characters after the dot indicate the document layout type (see :ref:`a_proj_roots`).
+
+Right-clicking an item in the project tree will open a context menu under the cursor, displaying
+a selection of actions that can be performed on the selected item.
+
+Below the project tree you will find a small details panel showing the full information of the
+currently selected item. This panel also includes the latest paragraph and character counts in
+addition to the word count.
+
+
+.. _a_ui_tree_novel:
+
+The Novel Tree
+--------------
+
+An alternative way to view the project structure is the novel tree. You can switch to this view by
+selecting the :guilabel:`Novel` tab under the project tree. This view is a simplified version of
+the view in the :guilabel:`Outline`. It is convenient when you want to browse the structure of the
+story itself rather than the document files.
+
+.. note::
+   You cannot reorganise the entries in the novel tree as that would imply restructuring the
+   content of the document files.
+
+
+.. _a_ui_tree_status:
+
+Document Importance and Status
+------------------------------
+
+Each document or folder in your project can have either a "Status" or "Importance" flag set. These
+are flags that you control and define in their respective tabs in :guilabel:`Project Settings`. The
+"Status" flag is intended to tag a Novel document as for instance a draft or as completed, and the
+"Importance" flag is intended to tag character notes, or other notes, as for instance a main, major
+or minor character.
+
+Whether a document uses a "Status" or "Importance" flag depends on which root folder it lives in.
+If it's in the :guilabel:`Novel` folder, it uses the "Status" flag, otherwise it uses an
+"Importance" flag. Some folders, like :guilabel:`Trash` and :guilabel:`Outtakes` allow both.
+
+
+.. _a_ui_tree_dnd:
+
+Project Tree Drag & Drop
+------------------------
+
+The project tree allows drag & drop to a certain extent. This feature is primarily intended for
+rearranging the order of your documents within each root folder, and has only limited support for
+moving documents elsewhere in the project tree. In general, bulk actions are not allowed. This is
+deliberate to avoid accidentally messing up your project. If you make a mistake, the last move
+action can be undone by pressing :kbd:`Ctrl`:kbd:`Shift`:kbd:`Z`.
+
+Documents and their folders can be rearranged freely within their root folders. Novel documents
+cannot be moved out of the :guilabel:`Novel` folder, except to :guilabel:`Trash` and the
+:guilabel:`Outtakes` folders. Notes can be moved freely between all root folders, but keep in mind
+that if you move a note into a :guilabel:`Novel`, its "Importance" setting will be reset to the
+default "Status" setting. See :ref:`a_ui_tree_status`.
+
+Folders cannot be moved at all outside their root tree. Neither can a folder containing documents
+be deleted. You must first delete the containing documents.
+
+Root folders in the project tree cannot be dragged and dropped at all. If you want to reorder them,
+you can move them up or down with respect to eachother from the :guilabel:`Project` menu, the
+right-click context menu, or by pressing :kbd:`Ctrl`:kbd:`Shift` and the :kbd:`Up` or :kbd:`Down`
+key.
+
+
+.. _a_ui_edit:
+
+Editing and Viewing Documents
+=============================
+
+To edit a document, double-click it in the project tree, or press the :kbd:`Return` key while
+having it selected. This will open the document in the document editor. The editor uses a
+simplified markdown format. The format is described in the :ref:`a_ui_md` section below. The editor
+has a maximise button (toggles the :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. If you have a middle mouse button, middle-clicking on the document will also open it in the
+viewer. The document viewed does not have to be the same document currently being edited. However,
+If you *are* viewing the same document, pressing :kbd:`Ctrl`:kbd:`R` again will update the document
+with your latest changes. You can also press the reload button in the top-right corner of the view
+panel next to the close button to achieve the same thing.
+
+Both the document editor and viewer will show the label of the document in the header at the top of
+the edit or view panel. Optionally, the full project path to the document can be shown. This can be
+set in :guilabel:`Preferences` from the :guilabel:`Tools` menu. Clicking on the document title bar
+will select and reveal its location in the project tree, making it easier to locate in a large
+project.
+
+Any tag reference in the editor can be opened in the viewer by moving the cursor to the label and
+pressing :kbd:`Ctrl`:kbd:`Return`. You can also control-click them with your mouse. In the viewer,
+the references become clickable links. Clicking them will replace the content of the viewer with
+the content of the document the reference points to. The document viewer keeps a history of viewed
+documents, which you can navigate with the arrow buttons in the top-left corner of the viewer. If
+your mouse has back and forward navigation buttons, these can be used as well. They work just like
+the backward and forward features in a browser.
+
+At the bottom of the view panel there is a :guilabel:`References` panel. (If it is hidden, click
+the icon to reveal it.) This panel will show links to all documents referring back to the one
+you're currently viewing, if any has been defined. The :guilabel:`Sticky` button will freeze the
+content of the panel to the current document, even if you navigate to another document. This is
+convenient if you want to quickly look through all documents in the list in the
+:guilabel:`References` panel without losing the list in the process.
+
+.. note::
+   The :guilabel:`References` panel relies on an up-to-date index of the project. The index is
+   maintained automatically. However, if anything is missing, or seems wrong, the index can always
+   be rebuilt by selecting :guilabel:`Rebuild Index` from the :guilabel:`Tools` menu, or by
+   pressing :kbd:`F9`.
+
+
+.. _a_ui_edit_search:
+
+Search & Replace
+----------------
+
+The document editor has a search and replace bar that can be activated with :kbd:`Ctrl`:kbd:`F` for
+search mode or :kbd:`Ctrl`:kbd:`H` for search/replace mode.
+
+Pressing :kbd:`Return` while in the search box will search for the next occurrence of the word, and
+:kbd:`Shift`:kbd:`Return` for the previous. Pressing :kbd:`Return` in the replace box, will replace
+the highlighted text and move to the next word.
+
+There are a number of settings for the search bar available as toggle switches above the search
+box. They allows you to search for, in order:,: matched case only, whole word results only, search
+using regular expressions, loop search when reaching the end of the document, and move to the next
+document when reaching the end. There is also a switch that will try to match the case of the word
+when the replacement is made. That is, it will try to keep the word upper, lower, or capitalised to
+match the word being replaced.
+
+The regular expression search is somewhat dependant on which version of Qt your system has. If you
+have Qt 5.13 or higher, there is better support for unicode symbols in the search.
+
+
+.. _a_ui_edit_auto:
+
+Auto-Replace as You Type
+========================
+
+A few auto-replace features are supported by the editor. You can control every aspect of the
+auto-replace feature from :guilabel:`Preferences`. You can also disable this feature entirely if
+you wish.
+
+.. tip::
+   If you don't like auto-replacement, all symbols inserted by this feature are also available in
+   the :guilabel:`Insert` menu, and via convenient :ref:`a_ui_shortcuts_ins`. You may also be using
+   a `Compose Key`_ setup, which means you may not need the auto-replace feature.
+
+.. _Compose Key: https://en.wikipedia.org/wiki/Compose_key
+
+The editor is able to replace two and three hyphens with short and long dashes, triple points with
+ellipsis, and replace straight single and double quotes with user-defined quote symbols. It will
+also try to determine whether to use the opening or closing symbol, although this feature isn't
+always accurate. Especially distinguishing between closing single quote and apostrophe can be
+tricky for languages that use the same symbol for these.
+
+.. tip::
+   If the auto-replace feature changes a symbol when you did not want it to change, pressing
+   :kbd:`Ctrl`:kbd:`Z` immediately after the auto-replacement will undo it without undoing the
+   character you typed.
+
+
+.. _a_ui_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 documents of layout ``Note``, they are free to be used as
+you see fit, but for all other 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 document 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's novel title.
+
+``## Title``
+   Heading level two. If the document is a novel file, the header level indicates the start of a
+   new chapter. Chapter numbers can be inserted automatically when exporting the manuscript.
+
+``### Title``
+   Heading level three. If the document is a novel file, the header level indicates the start of a
+   new scene. Scene numbers or scene separators can be inserted automatically when exporting the
+   manuscript, so you can use the title field as a working title for your scenes if you wish.
+
+``#### Title``
+   Heading level four. If the document is a novel file, the header level indicates the start of a
+   new section. Section titles can be replaced by separators or removed when exporting the
+   manuscript, so you can use the title field as a working title for your sections if you wish.
+
+.. note::
+   The space after the ``#`` characters is mandatory. The syntax highlighter will change colour and
+   font size when the heading is correctly formatted.
+
+.. tip::
+   If you do use the automatic numbering feature for exports, you can tell the export tool to skip
+   assigning a number to a specific chapter by adding a ``*`` as the first character of the title
+   itself. See :ref:`a_struct_heads_unnum` for more details.
+
+
+.. _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 also supports ``__``
+for strong and ``*`` for emphasis. However, since the differentiation makes the highlighting and
+conversion significantly simpler and faster, in novelWriter this is a rule, not just a
+recommendation.
+
+In addition, the following rules apply:
+
+1. The emphasis and strikethrough formatting tags do not allow spaces between the words and the tag
+   itself. That is, ``**text**`` is valid, ``**text **`` is not.
+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.
+4. Text emphasis does not span past line breaks. If you need to add emphasis to multiple lines or
+   paragraphs, you must apply it to each of them in turn.
+
+
+.. _a_ui_md_comm:
+
+Comments and Synopsis
+---------------------
+
+In addition to these standard markdown features, novelWriter also allows for comments in documents.
+The text of a comment is ignored by the word counter. The text can also be filtered out when
+exporting or viewing the document.
+
+If the first word of a comment is ``Synopsis:`` (with the colon included), the comment is treated
+specially and will show up in the :ref:`a_ui_outline` in a dedicated column. The word ``synopsis``
+is not case sensitive. If it is correctly formatted, the syntax highlighter will indicate this by
+altering the colour of the word.
+
+``% text...``
+   This is a comment. The text is not exported by default (this can be overridden), seen in the
+   document viewer, or counted towards word counts.
+
+``% Synopsis: text...``
+   This is a synopsis comment. It is generally treated in the same way as a regular comment, except
+   that it is also captured by the indexing algorithm and displayed in the :ref:`a_ui_outline`. It
+   can also be filtered separately when exporting the project to for instance generate an outline
+   document of the whole project.
+
+.. note::
+   Only one comment can be flagged as a synopsis comment for each heading. If multiple comments are
+   flagged as synopsis comments, the last one will be used and the rest ignored.
+
+
+.. _a_ui_md_tags:
+
+Tags and References
+-------------------
+
+The document editor supports a minimal set of keywords used for setting tags, and making references
+between documents. 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. They can
+also be inserted at the cursor position in the editor via the :guilabel:`Insert` menu.
+
+
+.. _a_ui_md_add:
+
+Additional Markdown and Non-Standard Features
+---------------------------------------------
+
+The editor and viewer also support markdown standard hard line breaks, and preserve non-breaking
+spaces if running with Qt 5.9 or higher. For older versions, the non-breaking spaces are lost when
+the document is saved. This is unfortunately hard-coded into the Qt text editor.
+
+* A hard line break can be achieved by leaving two or more spaces at the end of the line. This is
+  standard markdown syntax. Alternatively, the user can press :kbd:`Ctrl`:kbd:`K`, :kbd:`Return` to
+  insert this type of line break.
+* A non-breaking space can be inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Space`.
+* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl`:kbd:`K`,
+  :kbd:`Shift`:kbd:`Space`.
+* Non-breaking thin space can be inserted  with :kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`.
+
+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.
+
+.. tip::
+   Non-breaking spaces are the correct type of space to separate a number from its unit. Generally,
+   it prevents the line wrapping algorithms from adding line breaks where it shouldn't.
+
+
+.. _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 representing
+partitions, chapters, scenes and sections.
+
+The document containing the heading can also be displayed as a separate column, as well as the line
+number where it occurs. Double-clicking an entry will open the corresponding document in the
+editor.
+
+.. note::
+   Since the internal structure of the novel does not depend directly on the folder and document
+   structure of the project tree, these will not necessarily look the same, depending on how you
+   choose to organise your documents. See the :ref:`a_struct` page for more details.
+
+Various meta data and information extracted from tags can be displayed in columns in the outline.
+A default set of such columns is visible, but you can turn on or off more columns 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 contents change, you can always rebuild it manually by
+pressing :kbd:`F9` if something isn't right.
+
+The outline view itself can be regenerated by pressing :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,
+
+The :guilabel:`Synopsis` column of the outline view takes its information from a specially
+formatted comment. See :ref:`a_ui_md_comm`.
+
+
+.. _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:`Alt`:kbd:`4`",                 "Switch focus to outline view."
+   ":kbd:`Alt`:kbd:`Left`",              "Move backward in the view history of the document viewer."
+   ":kbd:`Alt`:kbd:`Right`",             "Move forward in the view history of the document viewer."
+   ":kbd:`Ctrl`:kbd:`.`",                "Open 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:`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`",                "Strikethrough selected text, or word under cursor."
+   ":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:`K`",                "Activate the insert commands. The commands are listed in :ref:`a_ui_shortcuts_ins`."
+   ":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:`Up`",               "Move item one step up in the project tree."
+   ":kbd:`Ctrl`:kbd:`Down`",             "Move item one step down in the project tree."
+   ":kbd:`Ctrl`:kbd:`Del`",              "Delete next word in editor."
+   ":kbd:`Ctrl`:kbd:`Backspace`",        "Delete previous word in editor."
+   ":kbd:`Ctrl`:kbd:`'`",                "Wrap selected text, or word under cursor, in single quotes."
+   ":kbd:`Ctrl`:kbd:`""`",               "Wrap selected text, or word under cursor, in double quotes."
+   ":kbd:`Ctrl`:kbd:`Retrun`",           "Open the tag or reference under the cursor in the Viewer."
+   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`,`",    "Open the :guilabel:`Project Settings` dialog."
+   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`/`",    "Remove block formatting for block under cursor."
+   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`1`",    "Replace occurrence of search word in current document, and search for next occurrence."
+   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`A`",    "Select all text in current paragraph."
+   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`G`",    "Find previous occurrence of search word in current document. (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:`Z`",    "Undo move of project tree item."
+   ":kbd:`Ctrl`:kbd:`Shift`:kbd:`Del`",  "If in the project tree, move a document to trash, or delete a folder."
+   ":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:`Shift`:kbd:`F6`",              "Open the :guilabel:`Project Details` dialog."
+   ":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`:kbd:`K`, followed by
+a key or key combination for the inserted content.
+
+.. 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:`Ctrl`:kbd:`_`",      "Insert a horizontal bar (quotation dash)."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`~`",                 "Insert a figure dash (same width as a number)."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`1`",                 "Insert a left single quote."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`2`",                 "Insert a right single quote."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`3`",                 "Insert a left double quote."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`4`",                 "Insert a right double quote."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`'`",                 "Insert a modifier apostrophe."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`.`",                 "Insert an ellipsis."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`'`",      "Insert a prime."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`""`",     "Insert a double prime."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`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."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`*`",                 "Insert a list bullet."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`−`",      "Insert a hyphen bullet (alternative bullet)."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`*`",      "Insert a flower mark (alternative bullet)."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`%`",                 "Insert a per mille symbol."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`O`",      "Insert a degree symbol."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`X`",      "Insert a times sign."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`D`",      "Insert a division sign."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`G`",                 "Insert a ``@tag`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`V`",                 "Insert a ``@pov`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`F`",                 "Insert a ``@focus`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`C`",                 "Insert a ``@char`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`P`",                 "Insert a ``@plot`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`T`",                 "Insert a ``@time`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`L`",                 "Insert a ``@location`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`O`",                 "Insert an ``@object`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`E`",                 "Insert an ``@entity`` keyword."
+   ":kbd:`Ctrl`:kbd:`K`, :kbd:`X`",                 "Insert a ``@custom`` keyword."

docs/source/usage_notes.rst

@@ -0,0 +1,50 @@
+.. _a_notes:
+
+*************
+Project Notes
+*************
+
+novelWriter doesn't have a database and complicated forms for filling in details about plot
+elements, characters, and all sorts of additional information that isn't a part of the novel text
+itself. Instead, all such information is saved in notes that are written and maintained just like
+all other text in your project.
+
+The relation between all these additional elements is extracted from the documents and notes by the
+project indexer, based on the tags and references you set within them.
+
+Using notes is not required, but making at least minimal notes for each plot element, and adding a
+tag to them, makes it possible to use the :guilabel:`Outline` feature to see how each element
+intersects with each section of the novel itself, and adds clickable cross-references between
+documents in the editor and viewer.
+
+
+.. _a_notes_tags:
+
+Tags in Notes
+=============
+
+Each new heading in a note can have a tag associated with it. The format of a tag is
+``@tag: tagname``, where tagname is a unique identifier. Tags can then be referenced in the novel
+documents, or cross-referenced in other notes, and will show up in the outline view and in the
+back-reference panel when a document is being viewed. See :ref:`a_struct_tags` for how to reference
+notes.
+
+The syntax highlighter will alert the user that the keyword is correctly used and that the tag is
+allowed, that is, the tag is unique. Duplicate tags should be detected as long as the index is up
+to date. An invalid tag should have a green wiggly line under it, and will not receive the syntax
+colour that valid tags do.
+
+The tag is the only part of these notes that the application uses. The rest of the document content
+is there for the writer to use in whatever way they wish. Of course, the content of the documents
+can be exported if you want to compile a single document of all your notes, or include them in an
+outline.
+
+A note can also reference other notes in the same way novel documents do. When the note is opened
+in the view panel, the references become clickable links, making it easier to follow connections in
+the plot. Notes don't show up in the outline view though, so referencing between notes is only
+meaningful if you want to be able to click-navigate between them.
+
+.. tip::
+   If you cross-reference between notes and export your project as an HTML document using the
+   :guilabel:`Build Novel Project` tool, the cross-references become clickable links in the
+   exported HTML document.

docs/source/usage_projects.rst

@@ -0,0 +1,335 @@
+.. _a_proj:
+
+**************
+Novel Projects
+**************
+
+A new project 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. See :ref:`a_tech` for further details on how files
+are organised.
+
+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 core novel documents go into a root folder of type :guilabel:`Novel`. Other supporting
+documents 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
+: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 documents have
+   other rules and features than other documents in the project. See :ref:`a_struct` for more
+   details.
+
+:guilabel:`Plot`
+   This is the root folder where main plots can be outlined. It is optional, but adding at least
+   dummy notes can be useful in order to tag plot elements for the Outline view. Tags in this
+   folder can be references using the ``@plot`` keyword.
+
+:guilabel:`Characters`
+   Character notes go in this root folder. These are especially important if 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 or focusing on a particular character's storyline. Tags in
+   this folder can be referenced using the ``@pov`` keyword for point-of-view characters,
+   ``@focus`` for a focus character, or the ``@char`` keyword for any other characters.
+
+: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
+   notes 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 in the project tree will still indicate what type they are, and so will the icon if you
+   are using one of the optional icon sets.
+
+
+.. _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 project index and cannot be
+referenced.
+
+Folders and root folders can only be deleted when they are empty. Recursive deletion is not
+supported. A document or a folder can be deleted from the :guilabel:`Project` menu, or by pressing
+:kbd:`Ctrl`:kbd:`Shift`:kbd:`Del`.
+
+
+.. _a_proj_roots_out:
+
+Archived Documents (Outtakes)
+-----------------------------
+
+If you don't want to delete a document, or put it in the :guilabel:`Trash` folder where it may be
+deleted, but still want it out of your main project tree, you can create an :guilabel:`Outtakes`
+root folder from the :guilabel:`Project` menu. You are not allowed to move entire folders to this
+root folder, only documents. If you need folders in it to organise your documents, you can of
+course create new ones there.
+
+You can drag any document to this folder and preserve its settings. The document will always be
+excluded from the :guilabel:`Build Novel Project` builds. It is also removed from the project
+index, so the tags and references defined in it will not show up anywhere else.
+
+
+.. _a_proj_roots_orph:
+
+Recovered Documents
+-------------------
+
+If novelWriter crashes or otherwise exits without saving the project state, or if you're using a
+file synchronisation tool that runs out of sync, there may be files in the project folder that
+aren't tracked in the core project file. These files, when discovered, are recovered and added back
+into the project if possible.
+
+The discovered files are scanned for meta information that gives clues as to where the document may
+previously have been located in the project. The project loading routines will try to put them back
+as close as possible to this location, if it still exists. Generally, it will be appended to the
+end of the folder where it previously was located. If that folder doesn't exist, it will try to add
+it to the correct root folder. If it cannot figure out which root folder is correct, the document
+will be added to the :guilabel:`Novel` root folder. Only if the :guilabel:`Novel` folder is
+missing will it give up.
+
+If the title of the document can be recovered, the word "Recovered:" will be added as a prefix. If
+the title cannot be determined, the document will be named "Recovered File N" where N is a
+sequential number.
+
+
+.. _a_proj_roots_lock:
+
+Project Lockfile
+----------------
+
+To prevent lost documents caused by file conflicts when novelWriter projects are synced with file
+synchronisation tools, a project lockfile is written to the project folder. If you try to open a
+project which has such a file present, you will be presented with a warning, and some information
+about where else novelWriter thinks the project is also open. You will be give the option to ignore
+this warning, and continue opening the project at your own risk.
+
+.. note::
+   If, for some reason, novelWriter crashes, the lock file may remain even if there are no other
+   instances keeping the project open. In such a case it is safe to ignore the lock file warning
+   when re-opening the project.
+
+.. warning::
+   If you choose to ignore the warning and continue opening the project, and multiple instances of
+   the project are in fact open, you are likely to cause inconsistencies and create diverging
+   project files, potentially resulting in loss of data and orphaned files. You are not likely to
+   lose any actual text unless both instances have the same document open in the editor, and
+   novelWriter will try to resolve 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 the novel, like for instance during export, these folders are
+ignored. Only the order of the documents themselves matter.
+
+The folders are there purely as a way for the user to organise the documents in meaningful sections
+and to be able to collapse and hide them in the project tree when you're not working on those
+documents.
+
+.. tip::
+   You can use folders to sort your scene documents into chapters. You will still need to add a
+   chapter document as the first item of your chapter folder, and the scene documents as the
+   following items. Another way to use folders is to make a folder for each act.
+
+
+.. _a_proj_files:
+
+Project Documents
+=================
+
+New documents 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 document, and open the :guilabel:`Item
+Settings` dialog where the document label and various other settings can be changed. This dialog
+can also be opened again later from either the :guilabel:`Project` menu, selecting :guilabel:`Edit
+Project Item`, or by pressing :kbd:`Ctrl`:kbd:`E` or :kbd:`F2` with the item selected.
+
+The layout of the document is also defined here. For Novel documents, the full list of layout
+options are available. For non-Novel documents, only :guilabel:`Note` is available. See
+:ref:`a_struct_layout` for more details.
+
+You can also select whether the document 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. You can also toggle the included
+state of a document from the right-click context menu.
+
+
+.. _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 header. The word count, and change of words in the current session, is
+displayed in the footer of any document open in the editor, and all stats are shown in the details
+panel below the project tree for any document selected in the project or novel tree.
+
+The word counts are not updated in real time, but run 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 throughout 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 features may be using them,
+and they are exported on some export formats in the :guilabel:`Build Novel Project` tool.
+
+If your project is in a different language than your main spell checking is set to, you can
+override the default spell checking language here. You can also override the automatic backup
+setting.
+
+
+Status and Importance Tabs
+--------------------------
+
+Each document or folder of type :guilabel:`Novel` can be given a status level, signified by a
+coloured icon, and each document or folder of the remaining types can be given an importance level.
+These are colour coded icons and labels that can be applied to each document or folder.
+
+These are purely there for the user's 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 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.
+
+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 exports.
+
+The auto-replace feature will replace text in angle brackets that are in this list. The syntax
+highlighter will add an alternate colour to text marching 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 entire project folder, and
+are stored in a subfolder of the backup path. The subfolder will have 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 disable 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 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. You can view this
+file in the ``meta`` folder in the directory where you saved your project. The file is named
+``sessionStats.log``.
+
+A tool to view the content of this file is available in the :guilabel:`Tools` menu under
+:guilabel:`Writing Statistics`. You can also launch it by pressing :kbd:`F6`.
+
+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.
+
+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, and 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/usage_structure.rst

@@ -0,0 +1,250 @@
+.. _a_struct:
+
+***************
+Novel Structure
+***************
+
+This section covers the structure of a novel project.
+
+It concerns documents under the :guilabel:`Novel` type root folder only. There are some
+restrictions and features that only apply to these types of documents.
+
+
+.. _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 documents.
+
+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 as well as the
+   :guilabel:`Novel` tab of the project tree. Each heading also starts a new region where new
+   references and tags can be defined.
+
+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. The latter is useful 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 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.
+
+``### Header3``
+   Header level three 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 export your
+   manuscript.
+
+``#### Header4``
+   Header level four signifies a sub-scene level partition, usually called a "section" in the
+   documentation and the user interface. These can be useful if you want to change tag references
+   mid-scene, like if you change the point-of-view character. You are free to use sections as you
+   wish, and can filter them out of the final manuscript just like with scene titles.
+
+.. tip::
+   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_heads_unnum:
+
+Unnumbered Chapter Headings
+---------------------------
+
+If you use layout types for your documents, the automatic numbering feature for your chapters is
+controlled by whether you use the :guilabel:`Chapter` or :guilabel:`Unnumbered` layout type for
+your document. However, if you have a different document layout where this isn't practical, you can
+also switch off chapter numbering for a chapter by making the first character of the chapter title
+an asterisk (``*``). Like so:
+
+``## *Unnumbered Chapter Title``
+
+The leading asterisk is only considered by the :guilabel:`Build Novel Project` tool, and will be
+removed before the title is inserted at the location of the ``%title%`` label. See the
+:ref:`a_export` page for more details.
+
+.. note::
+   If you need the first character of the title to be an actual asterisk, you must escape it:
+   ``\*``.
+
+
+.. _a_struct_tags:
+
+Tag References
+==============
+
+Each text partition, indicated by a heading of any level, can contain references to tags set in the
+supporting notes of the project. The references are gathered by the indexer and used to generate an
+outline view on the :guilabel:`Outline` tab of how the different parts of the novel are connected.
+This section covers how to set references to tags. See :ref:`a_notes_tags` for how to define tags
+the references can point to.
+
+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.
+
+``@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 the
+   :guilabel:`Character` type root folder.
+
+``@char``
+   Other characters in the current section. The target must be a note tag in the
+   :guilabel:`Character` type root folder. This should not include the point-of-view character.
+
+``@plot``
+   The plot or subplot advanced in the current section. The target must be a note tag in the
+   :guilabel:`Plot` type root folder.
+
+``@time``
+   The timelines touched by the current section. The target must be a note tag in the
+   :guilabel:`Timeline` type root folder.
+
+``@location``
+   The location the current section takes place in. The target must be a note tag in the
+   :guilabel:`Locations` type root folder.
+
+``@object``
+   Objects present in the current section. The target must be a note tag in the :guilabel:`Object`
+   type root folder.
+
+``@entity``
+   Entities present in the current section. The target must be a note tag in the
+   :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 document is regenerated when it is saved, so this shouldn't normally be necessary.
+
+
+.. _a_struct_layout:
+
+Novel Document Layout
+=====================
+
+All documents in the 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 text formatting,
+headings, and page breaks. The layout for each document 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, they also help to indicate what each
+document is intended for in your project. The :guilabel:`Book` layout is a generic novel document
+layout that is formatted identically to :guilabel:`Chapter` and :guilabel:`Scene` layout documents,
+but may help to indicate what each document does in your project.
+
+You can for instance lay out your project using :guilabel:`Book` documents for each act, and then
+later split those into chapter or scene documents by using the :guilabel:`Split Document` tool.
+Scenes can also be contained within :guilabel:`Chapter` type documents, but you lose the drag and
+drop feature that comes with having them in separate documents if you organise them this way.
+
+Some layouts *do* have implications on how the project is exported. Documents 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.
+
+The above layout formats are only usable in the Novel root folder. Documents that are not a part of
+the novel itself should have the :guilabel:`Note` layout. These documents are not getting any
+special formatting, and it is possible to collectively filter them out during export. Notes can be
+used anywhere in the project, also in the :guilabel:`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 centred
+   on export.
+
+: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 format that in principle can be used for all novel documents. Since
+   the internal structure of the novel is controlled by the heading levels, this layout will
+   produce the same result as a collection of :guilabel:`Partition`, :guilabel:`Chapter` and
+   :guilabel:`Scene` layout documents. However, it does not provide the functionality of the
+   :guilabel:`Unnumbered` layout format by default, but this can still be achieved by prefixing the
+   chapter title with an asterisk (``*``). See :ref:`a_struct_heads_unnum` for more details.
+
+: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`
+   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 documents, these
+   documents 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 project, and automatic chapter numbering is
+   enabled, documents with this layout will not increment and apply a chapter number. It also has a
+   separate title formatting setting. This makes the layout suitable for Prologue and Epilogue type
+   chapters.
+
+:guilabel:`Scene`
+   Used for scenes. This document should have a header of level three. Further sections can have
+   headers of level four, but there are no layout specifically for sections.
+
+:guilabel:`Note`
+   A generic document that is optionally ignored when the novel project is exported. Use this
+   layout for descriptions of content in the supporting root folders. Notes can also be added to
+   the :guilabel:`Novel` root folder if you need to insert notes there. Note 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 document with layout :guilabel:`Book`. You can also have a single document per chapter if
+   that suits you better. The :guilabel:`Outline` will show your structure of chapters and scenes
+   regardless of how your documents are organised. So will the novel tree.
+
+.. tip::
+   You can always start writing with a coarse layout with one or a few documents, and then later
+   use the split tool to automatically split the documents into separate chapter and scene
+   documents. The split tool will try to select the correct layout for each of the new documents.
+
+
+.. _a_struct_layout_auto:
+
+Novel Layout Automation
+-----------------------
+
+When a document is saved from the document editor, novelWriter will check if the level of the first
+header of the document matches the selected document layout. If the header level is inconsistent
+with the layout, the layout will automatically be corrected if it can be unambiguously determined.
+
+This means that for instance saving a document with header level three, when the layout is set to
+:guilabel:`Chapter`, the layout will automatically be changed to :guilabel:`Scene`. If, however,
+the layout was set to :guilabel:`Book`, no change will be made because the :guilabel:`Book` layout
+is not associated with a specific header level.

docs/source/usage_typography.rst

@@ -0,0 +1,104 @@
+.. _a_typ:
+
+*******************
+Typographical Notes
+*******************
+
+novelWriter has some support for typographical symbols that are not usually easily available in
+many text editors. This includes for instance the proper unicode quotation marks, dashes, ellipsis,
+thin spaces, etc. All these symbols are available from the :guilabel:`Insert` menu, and via
+keyboard shortcuts. See :ref:`a_ui_shortcuts_ins`.
+
+This chapter provides some additional information on how novelWriter handles these symbols.
+
+
+.. _a_typ_notes:
+
+Special Notes on Symbols
+========================
+
+Some additional notes on the available symbols.
+
+
+Dashes and Ellipsis
+-------------------
+
+With the auto-replace feature enabled (see :ref:`a_ui_edit_auto`), multiple hyphens are converted
+automatically to short and long dashes, and three dots to ellipsis. The last auto-replace can
+always be reverted with the undo command :kbd:`Ctrl`:kbd:`Z`, reverting the text to what you typed
+before the automatic replacement occurred.
+
+In addition, "Figure Dash" is available. The Figure Dash is a dash that has the same width as the
+numbers of the same font, for most fonts. It helps to align numbers align nicely in columns when
+you need to use a dash in them.
+
+
+Single and Double Quotes
+------------------------
+
+All the different quotation marks listed on the `Quotation Mark`_ Wikipedia page are available, and
+can be selected as auto-replaced symbols for straight single and double quote key strokes. The
+settings can be found in :guilabel:`Preferences`.
+
+Ordinarily, text wrapped in quotes are highlighted by the editor. This is meant as a convenience
+for highlighting dialogue between characters. This feature can be disabled in
+:guilabel:`Preferences` if this feature isn't wanted.
+
+The editor distinguishes between text wrapped in regular straight quotes and with the user-selected
+double quote symbols. This is to help the writer recognise which parts of the text are not using
+the chosen quote symbols. Two convenience functions in the :guilabel:`Format` menu can be used to
+re-format a selected section of text with the correct quote symbols.
+
+.. _Quotation Mark: https://en.wikipedia.org/wiki/Quotation_mark
+
+
+Single and Double Prime
+------------------------
+
+Both single and double prime symbols are available in the :guilabel:`Insert` menu. These symbols
+are the correct symbols to use for unit symbols for feet, inches, minutes and seconds. The usage of
+these is described in more detail on the Wikipedia Prime_ page. They look very similar to single
+and double straight quotes, and may be renderred similarly by the font, but they have different
+codes. Using these correctly will also prevent the auto-replace and dialogue highlighting features
+misunderstanding their meaning in the text.
+
+.. _Prime: https://en.wikipedia.org/wiki/Prime_(symbol)
+
+
+Modifier Letter Apostrophe
+--------------------------
+
+The auto-replace feature will consider any right-facing single straight quote as a quote symbol,
+even if it is intended as an apostrophe. This also includes the syntax highlighter, which may
+assume the first following apostrophe is the closing symbol of a single quoted region of text.
+
+To get around this, an alternative apostrophe is available. It is a special Unicode character that
+is not categorised as punctuation, but as a modifier. It is usually renderred the same way as the
+right single quotation marks, depending on the font. There is a Wikipedia article for the
+`Modifier letter apostrophe`_ with more details.
+
+.. note::
+   On export with the :guilabel:`Build Novel Project` tool, these apostrophes will be replaced
+   automatically with the corresponding right hand single quote symbol as is generally recommended.
+   Therefore it doesn't really matter if you only use them to correct highlighting.
+
+.. _Modifier letter apostrophe: https://en.wikipedia.org/wiki/Modifier_letter_apostrophe
+
+
+Special Space Symbols
+---------------------
+
+A few variations of the regular space character is supported. The correct typographical way to
+separate a number from its unit is with a `thin space`_. It is usually 2/3 the width of a regular
+space. For numbers and units, this should in addition be a non-breaking space, that is, the text
+wrapping should not add a line break on this particular space.
+
+A regular space can also be made into a non-breaking space if needed.
+
+All non-breaking spaces are highlighted with a differently coloured background to make it easier to
+spot them in the text. The colour will depend on the selected colour theme.
+
+The thin and non-breaking spaces are converted to their corresponding HTML codes on export to HTML
+format.
+
+.. _thin space: https://en.wikipedia.org/wiki/Thin_space

i18n/README.md

@@ -0,0 +1,79 @@
+# novelWriter Internationalisation
+
+The `i18n` folder contains the translation files for the Qt5 GUI. There are two types of files
+involved: the `nw_XX.ts` and the `nw_XX.qm` files. The `nw_XX.ts` files are located in the `i18n`
+folder at the root of the repository, and the `nw_XX.qm` together with the `project_XX.json` files
+are located in `nw/assets/i18n`. The latter are JSON files translation maps for the novelWriter
+projects, used by the Build Novel Project tool.
+
+## Qt GUI Localisation
+
+The `.qm` files are the actual files used by the application to translate the GUI into another
+language other than the default British English. The files are not generated by default. They can
+be built with:
+```bash
+python3 setup.py qtlrelease
+```
+
+To add a new translation file, first add a new entry in the `novelWriter.pro` file under the
+`TRANSLATIONS` variable. Please use the underscore syntax for file names as the importer expects
+this format.
+
+After adding the entry in the `.pro` file, run:
+```bash
+python3 setup.py qtlupdate
+```
+
+This will build a new `i18n/nw_XX.ts` file for the language you just added. The file can then be
+edited with the Qt 5 Linguist application provided by Qt. This is by far easier than manually
+editing the `.ts` file. Please select "English" and "United Kingdom" as the source langauge when
+prompted by Qt 5 Linguist.
+
+When you're done editing, you can build the `nw/assets/i18n/nw_XX.qm` file and test it in
+novelWriter. The Preferences dialog should list the newly added language, and you can select it and
+test it.
+
+Please do not submit the `.qm` files to the repository. Only the `.ts` files in the `i18n` folder
+are needed.
+
+**Note**
+
+These commands require that you have the tools Qt 5 Linguist and the PyQt5 tool `pylupdate5`
+installed on your system.
+
+For Ubuntu/Debian, run:
+```bash
+sudo apt install qttools5-dev-tools pyqt5-dev-tools
+```
+
+### Missing QtBase Translations
+
+The default Qt dialogs also have translations, for instance for standard buttons for "Yes", "No",
+"Ok", "Cancel", etc. Generally, these translations files are installed with the Qt libraries on
+your system, and novelWriter will collect those translations from there. However, these
+translations are missing for many languages.
+
+As a starting point, there is no need to translate any entries in the `.ts` files that are under
+elements starting with the letter "Q", like "QPlatformTheme", "QWizard", etc. If these turn up in
+English in novelWriter after activating a translation, it means they are probably missing in the Qt
+library, and you may also need to translate these.
+
+These additional translation entries are generated from a file named `i18n/qtbase.py`, which is not
+a file that novelWriter uses. It is there only to generate these additional entries for the `.ts`
+files.
+
+## Project Localisation
+
+Projects can have a different language setting than the GUI itself. The files with format
+`project_XX.json` in `nw/assets/i18n` are simple translation maps for text that goes into the
+exported documents generated by the Build Novel Project tool.
+
+The files are loaded based on the language setting in the build tool. At the present time, no other
+parts of the application use these files. Since these are used as replacement lookups, they are
+maintained as plain JSON files. The main usage is to generate chapter headers as number words.
+
+Adding new translations for these files is easy. Just copy the `project_en.json` file, rename it to
+the appropriate language coded filename, and edit it. Please use the underscore as separator if a
+language needs to be localised to a specific country under a language. The importer will for
+instance look for `en_US` first, then use `en` if it is not found. If there are no matching files,
+the project falls back to using English.

i18n/qtbase.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+"""
+Qt Base Translation File
+========================
+
+This file causes Qt Linguist to generate translation entries for the Qt
+elements that need translation in novelWriter for those languages who do
+not yet have a qtbase_xx.qm file shipped with Qt.
+
+If a qtbase_xx.qm file already exists, do not add a translation for the
+entries generated from this file.
+"""
+
+from PyQt5.QtCore import QT_TRANSLATE_NOOP
+
+# QDialogButtonBox
+# ================
+
+QT_TRANSLATE_NOOP("QDialogButtonBox", "OK")
+
+# QGnomeTheme
+# ===========
+
+QT_TRANSLATE_NOOP("QGnomeTheme", "&OK")
+QT_TRANSLATE_NOOP("QGnomeTheme", "&Save")
+QT_TRANSLATE_NOOP("QGnomeTheme", "&Cancel")
+QT_TRANSLATE_NOOP("QGnomeTheme", "&Close")
+QT_TRANSLATE_NOOP("QGnomeTheme", "Close without Saving")
+
+# QGuiApplication
+# ===============
+
+QT_TRANSLATE_NOOP("QGuiApplication", (
+    "Translate this string to the string 'LTR' in left-to-right languages or to "
+    "'RTL' in right-to-left languages (such as Hebrew and Arabic) to get proper widget layout."
+))
+
+# QPlatformTheme
+# ==============
+
+QT_TRANSLATE_NOOP("QPlatformTheme", "OK")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Save")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Save All")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Open")
+QT_TRANSLATE_NOOP("QPlatformTheme", "&Yes")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Yes to &All")
+QT_TRANSLATE_NOOP("QPlatformTheme", "&No")
+QT_TRANSLATE_NOOP("QPlatformTheme", "N&o to All")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Abort")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Retry")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Ignore")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Close")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Cancel")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Discard")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Help")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Apply")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Reset")
+QT_TRANSLATE_NOOP("QPlatformTheme", "Restore Defaults")
+
+# QWizard
+# =======
+
+QT_TRANSLATE_NOOP("QWizard", "Go Back")
+QT_TRANSLATE_NOOP("QWizard", "< &Back")
+QT_TRANSLATE_NOOP("QWizard", "Continue")
+QT_TRANSLATE_NOOP("QWizard", "&Next")
+QT_TRANSLATE_NOOP("QWizard", "&Next >")
+QT_TRANSLATE_NOOP("QWizard", "Commit")
+QT_TRANSLATE_NOOP("QWizard", "Done")
+QT_TRANSLATE_NOOP("QWizard", "&Finish")
+QT_TRANSLATE_NOOP("QWizard", "Cancel")
+QT_TRANSLATE_NOOP("QWizard", "Cancel")
+QT_TRANSLATE_NOOP("QWizard", "Help")
+QT_TRANSLATE_NOOP("QWizard", "&Help")

install.py

@@ -1,85 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-import os
-import sys
-import getopt
-import subprocess
-
-# Defaults
-buildWindowed = True
-
-# Parse Options
-shortOpt = "hd"
-longOpt  = [
-    "help",
-    "debug",
-]
-helpMsg = (
-    "\n"
-    "novelWriter Install Script\n"
-    "\n"
-    "Usage:\n"
-    " -h, --help   Print this message.\n"
-    " -d, --debug  Build novelWriter for debugging. To debug novelwriter after build,\n"
-    "              run it from command line with the debug options. Please check the\n"
-    "              novelWriter --help output for details.\n"
-)
-
-try:
-    inOpts, inArgs = getopt.getopt(sys.argv[1:],shortOpt,longOpt)
-except getopt.GetoptError:
-    print(helpMsg)
-    sys.exit(2)
-
-for inOpt, inArg in inOpts:
-    if inOpt in ("-h","--help"):
-        print(helpMsg)
-        sys.exit()
-    elif inOpt in ("-d", "--debug"):
-        buildWindowed = False
-
-# Run pip
-packList = ["pyinstaller"]
-with open("requirements.txt",mode="r") as reqFile:
-    for reqPack in reqFile:
-        if len(reqPack.strip()) > 0:
-            packList.append(reqPack)
-
-for packName in packList:
-    print("Installing package dependency: %s" % packName)
-    try:
-        subprocess.call([sys.executable, "-m", "pip", "install", packName])
-    except Exception as e:
-        print("Failed with error:")
-        print(str(e))
-
-# Run pyinstaller
-if sys.platform.startswith("win32"):
-    dotDot = ";"
-else:
-    dotDot = ":"
-
-instOpt = [
-    "--name=novelWriter",
-    "--onefile",
-    "--add-data=%s%s%s" % (os.path.join("nw", "themes"),  dotDot,"themes"),
-    "--add-data=%s%s%s" % (os.path.join("nw", "graphics"),dotDot,"graphics"),
-    "--icon=%s" % os.path.join("nw", "graphics", "novelWriter.ico"),
-]
-if buildWindowed:
-    instOpt.append("--windowed")
-
-instOpt.append("novelWriter.py")
-
-import PyInstaller.__main__
-PyInstaller.__main__.run(instOpt)
-
-print("")
-print("##################")
-print("  Build Finished")
-print("##################")
-print("")
-print("If everything went well, the novelWriter executable should be in the folder named 'dist'")
-print("")
-

novelWriter.pro

@@ -0,0 +1,38 @@
+SOURCES += \
+    i18n/qtbase.py \
+    nw/core/document.py \
+    nw/core/project.py \
+    nw/core/tokenizer.py \
+    nw/dialogs/about.py \
+    nw/dialogs/docmerge.py \
+    nw/dialogs/docsplit.py \
+    nw/dialogs/itemeditor.py \
+    nw/dialogs/preferences.py \
+    nw/dialogs/projload.py \
+    nw/dialogs/projsettings.py \
+    nw/dialogs/wordlist.py \
+    nw/gui/custom.py \
+    nw/gui/doceditor.py \
+    nw/gui/docviewer.py \
+    nw/gui/itemdetails.py \
+    nw/gui/mainmenu.py \
+    nw/gui/noveltree.py \
+    nw/gui/outline.py \
+    nw/gui/outlinedetails.py \
+    nw/gui/projdetails.py \
+    nw/gui/projtree.py \
+    nw/gui/statusbar.py \
+    nw/gui/theme.py \
+    nw/tools/build.py \
+    nw/tools/projwizard.py \
+    nw/tools/writingstats.py \
+    nw/common.py \
+    nw/constants.py \
+    nw/error.py \
+    nw/guimain.py
+
+TRANSLATIONS += \
+    i18n/nw_en_US.ts \
+    i18n/nw_fr.ts \
+    i18n/nw_nb_NO.ts \
+    i18n/nw_pt.ts

novelWriter.py

@@ -1,49 +1,22 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-
+"""
+novelWriter – Start Script
+==========================
+"""
+import os
 import sys
 
-if sys.hexversion < 0x030500F0:
-    print("ERROR: At least Python 3.5 is required")
-    exit(1)
-
 try:
-    import PyQt5.QtWidgets
-    import PyQt5.QtGui
-    import PyQt5.QtCore
-except:
-    print("ERROR: Failed to load dependency python3-pyqt5")
-    exit(1)
+    import PyQt5.QtWidgets # noqa: F401
+    import PyQt5.QtGui # noqa: F401
+    import PyQt5.QtCore # noqa: F401
+except Exception:
+    print("ERROR: Failed to load dependency PyQt5")
+    sys.exit(1)
 
-try:
-    import PyQt5.QtSvg
-except:
-    print("ERROR: Failed to load dependency python3-pyqt5.qtsvg")
-    exit(1)
-
-try:
-    import lxml
-except:
-    print("ERROR: Failed to load dependency python3-lxml")
-    exit(1)
-
-try:
-    import appdirs
-except:
-    print("ERROR: Failed to load dependency python3-appdirs")
-    exit(1)
-
-spellPack = None
-try:
-    import enchant
-    spellPack = "enchant"
-except:
-    print("WARNING: No spell check library found.")
-    print("Please install python3-enchant if you want to use spell checking")
+os.curdir = os.path.abspath(os.path.dirname(__file__))
 
 if __name__ == "__main__":
     import nw
-    inArgs = sys.argv[1:]
-    if spellPack is not None:
-        inArgs.append("--spell=%s" % spellPack)
-    nw.main(inArgs)
+    nw.main(sys.argv[1:])

nw/__init__.py

@@ -1,41 +1,80 @@
 # -*- coding: utf-8 -*-
-"""novelWriter Init
+"""
+novelWriter – Init File
+=======================
+Application initialisation
 
- novelWriter – Init File
-=========================
- Application initialisation
+File History:
+Created: 2018-09-22 [0.0.1]
 
- File History:
- Created: 2018-09-22 [0.0.1]
+This file is a part of novelWriter
+Copyright 2018–2021, Veronica Berglyd Olsen
 
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 
 import sys
 import getopt
 import logging
 
-from os              import path, remove, rename
-from PyQt5.QtWidgets import QApplication
-from nw.gui.winmain  import GuiMain
-from nw.config       import Config
+from PyQt5.QtGui import QIcon
+from PyQt5.QtWidgets import QApplication, QErrorMessage
 
-__package__    = "novelWriter"
-__author__     = "Veronica Berglyd Olsen"
-__copyright__  = "Copyright 2018–2019, Veronica Berglyd Olsen"
+from nw.error import exceptionHandler, logException
+from nw.config import Config
+
+##
+#  Version Scheme
+# ================
+#  Generally follows PEP 440
+#  Hex Version:
+#  - Digit 1,2 : Major Version (01-ff)
+#  = Digit 3,4 : Minor Version (01-ff)
+#  - Digit 5,6 : Patch Version (01-ff)
+#  = Digit 7   : Release Type (a: aplha, b: beta, c: candidate, f: final)
+#  - Digit 8   : Release Number (0-f)
+#
+#  Example    : Full        Short      Description
+# -------------------------------------------------------------------------
+#  0x010200a0 : 1.2-alpha0  1.2a0      Can be used for the dev branch
+#  0x010200a1 : 1.2-alpha1  1.2a1      First alpha release
+#  0x010200b1 : 1.2-beta1   1.2b1      First beta release
+#  0x010200c1 : 1.2-rc1     1.2rc1     First release candidate
+#  0x010200f0 : 1.2         1.2        Final release
+#  0x010200f1 : 1.2-post1   1.2.post1  Post release, but not a code patch!
+#  0x010201f0 : 1.2.1       1.2.1      Patch release
+##
+
+__package__    = "nw"
+__copyright__  = "Copyright 2018–2021, Veronica Berglyd Olsen"
 __license__    = "GPLv3"
-__version__    = "0.4.0"
-__date__       = "2019-11-03"
+__author__     = "Veronica Berglyd Olsen"
 __maintainer__ = "Veronica Berglyd Olsen"
 __email__      = "code@vkbo.net"
-__status__     = "Development"
-__url__        = "https://github.com/vkbo/novelWriter"
+__version__    = "1.3.2"
+__hexversion__ = "0x010302f0"
+__date__       = "2021-05-30"
+__status__     = "Stable"
+__domain__     = "novelwriter.io"
+__url__        = "https://novelwriter.io"
+__sourceurl__  = "https://github.com/vkbo/novelWriter"
+__issuesurl__  = "https://github.com/vkbo/novelWriter/issues"
+__helpurl__    = "https://github.com/vkbo/novelWriter/discussions"
+__releaseurl__ = "https://github.com/vkbo/novelWriter/releases/latest"
 __docurl__     = "https://novelwriter.readthedocs.io"
-__credits__    = [
-    "Veronica Berglyd Olsen (developer)",
-    "Marian Lückhof (contributor, tester)"
-]
 
-#
+##
 #  Logging
 # =========
 #  Standard used for logging levels in novelWriter:
@@ -46,23 +85,23 @@ __credits__    = [
 #  ----------- SPAM Threshold : Output above should be minimal -----------------
 #    DEBUG     Use for descriptions of main program flow
 #    VERBOSE   Use for outputting values and program flow details
-#
+##
 
-# Adding verbose logging levels
+# Add verbose logging level
 VERBOSE = 5
 logging.addLevelName(VERBOSE, "VERBOSE")
 def logVerbose(self, message, *args, **kws):
     if self.isEnabledFor(VERBOSE):
         self._log(VERBOSE, message, args, **kws)
+
 logging.Logger.verbose = logVerbose
 
 # Initiating logging
 logger = logging.getLogger(__name__)
 
-#
+##
 #  Main Program
-# ==============
-#
+##
 
 # Load the main config as a global object
 CONFIG = Config()
@@ -70,141 +109,184 @@ CONFIG = Config()
 def main(sysArgs=None):
     """Parses command line, sets up logging, and launches main GUI.
     """
-
     if sysArgs is None:
         sysArgs = sys.argv[1:]
 
     # Valid Input Options
-    shortOpt = "hdDqtl:v"
+    shortOpt = "hv"
     longOpt  = [
         "help",
+        "version",
+        "info",
         "debug",
         "verbose",
-        "debuggui",
-        "quiet",
-        "time",
-        "logfile=",
-        "version",
-        "config=",
-        "testmode",
-        "spell=",
         "style=",
+        "config=",
+        "data=",
+        "testmode",
     ]
 
     helpMsg = (
-        "{appname} {version} ({status})\n"
+        "novelWriter {version} ({date})\n"
         "{copyright}\n"
         "\n"
+        "This program is distributed in the hope that it will be useful,\n"
+        "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
+        "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
+        "GNU General Public Licence for more details.\n"
+        "\n"
         "Usage:\n"
-        " -h, --help      Print this message.\n"
-        " -v, --version   Print program version and exit.\n"
-        " -d, --debug     Print debug output.\n"
-        "     --verbose   Increase verbosity of debug output.\n"
-        " -D, --debuggui  Shows additional debug GUI elements. Includes -d.\n"
-        " -q, --quiet     Disable output to command line. Does not affect log file.\n"
-        " -t, --time      Shows time stamp in logging output. Adds milliseconds when --verbose.\n"
-        " -l, --logfile=  Specify log file.\n"
-        "     --style=    Set Qt5 style flag. Defaults to Fusion.\n"
-        "     --config=   Alternative config file.\n"
-        "     --headless  Do not display GUI. Useful for testing scripts.\n"
+        " -h, --help     Print this message.\n"
+        " -v, --version  Print program version and exit.\n"
+        "     --info     Print additional runtime information.\n"
+        "     --debug    Print debug output. Includes --info.\n"
+        "     --verbose  Increase verbosity of debug output. Includes --debug.\n"
+        "     --style=   Sets Qt5 style flag. Defaults to 'Fusion'.\n"
+        "     --config=  Alternative config file.\n"
+        "     --data=    Alternative user data path.\n"
     ).format(
-        appname   = __package__,
         version   = __version__,
-        status    = __status__,
-        copyright = __copyright__
+        copyright = __copyright__,
+        date      = __date__,
     )
 
     # Defaults
-    debugLevel = logging.WARN
-    debugStr   = "{levelname:8}  {message:}"
-    timeStr    = "[{asctime:}] "
-    logFile    = ""
-    toFile     = False
-    toStd      = True
-    showTime   = False
-    confPath   = None
-    testMode   = False
-    debugGUI   = False
-    spellTool  = None
-    qtStyle    = "Fusion"
+    logLevel  = logging.WARN
+    logFormat = "{levelname:8}  {message:}"
+    confPath  = None
+    dataPath  = None
+    testMode  = False
+    qtStyle   = "Fusion"
+    cmdOpen   = None
 
     # Parse Options
     try:
-        inOpts, inArgs = getopt.getopt(sysArgs,shortOpt,longOpt)
-    except getopt.GetoptError:
+        inOpts, inRemain = getopt.getopt(sysArgs, shortOpt, longOpt)
+    except getopt.GetoptError as E:
         print(helpMsg)
+        print("ERROR: %s" % str(E))
         sys.exit(2)
 
+    if len(inRemain) > 0:
+        cmdOpen = inRemain[0]
+
     for inOpt, inArg in inOpts:
-        if inOpt in ("-h","--help"):
+        if inOpt in ("-h", "--help"):
             print(helpMsg)
-            sys.exit()
+            sys.exit(0)
         elif inOpt in ("-v", "--version"):
-            print("%s %s Version %s" % (__package__,__status__,__version__))
-            sys.exit()
-        elif inOpt in ("-d", "--debug"):
-            debugLevel = logging.DEBUG
-            debugStr   = "{name:>30}:{lineno:<4d}  {levelname:8}  {message:}"
-        elif inOpt in ("-l","--logfile"):
-            logFile = inArg
-            toFile  = True
-        elif inOpt in ("-q","--quiet"):
-            toStd = False
-        elif inOpt in ("--verbose"):
-            debugLevel = VERBOSE
-            timeStr    = "[{asctime:}.{msecs:03.0f}] "
-        elif inOpt in ("-t","--time"):
-            showTime = True
-        elif inOpt in ("--style"):
+            print("novelWriter Version %s [%s]" % (__version__, __date__))
+            sys.exit(0)
+        elif inOpt == "--info":
+            logLevel = logging.INFO
+        elif inOpt == "--debug":
+            logLevel = logging.DEBUG
+            logFormat  = "[{asctime:}] {name:>22}:{lineno:<4d}  {levelname:8}  {message:}"
+        elif inOpt == "--verbose":
+            logLevel = VERBOSE
+            logFormat  = "[{asctime:}] {name:>22}:{lineno:<4d}  {levelname:8}  {message:}"
+        elif inOpt == "--style":
             qtStyle = inArg
-        elif inOpt in ("--config"):
+        elif inOpt == "--config":
             confPath = inArg
-        elif inOpt in ("--testmode"):
+        elif inOpt == "--data":
+            dataPath = inArg
+        elif inOpt == "--testmode":
             testMode = True
-        elif inOpt in ("--spell"):
-            spellTool = inArg
-        elif inOpt in ("-D","--debuggui"):
-            debugLevel = logging.DEBUG
-            debugStr   = "{name:>20}:{lineno:<4d}  {levelname:8}  {message:}"
-            debugGUI   = True
 
     # Set Config Options
-    CONFIG.showGUI   = not testMode
-    CONFIG.debugGUI  = debugGUI
-    CONFIG.debugInfo = debugLevel < logging.INFO
-    CONFIG.spellTool = spellTool
+    CONFIG.cmdOpen = cmdOpen
 
     # Set Logging
-    if showTime: debugStr = timeStr+debugStr
-    logFmt = logging.Formatter(fmt=debugStr,datefmt="%Y-%m-%d %H:%M:%S",style="{")
+    cHandle = logging.StreamHandler()
+    cHandle.setFormatter(logging.Formatter(fmt=logFormat, style="{"))
 
-    if not logFile == "" and toFile:
-        if path.isfile(logFile+".bak"):
-            remove(logFile+".bak")
-        if path.isfile(logFile):
-            rename(logFile,logFile+".bak")
+    pkgLogger = logging.getLogger(__package__)
+    pkgLogger.addHandler(cHandle)
+    pkgLogger.setLevel(logLevel)
 
-        fHandle = logging.FileHandler(logFile)
-        fHandle.setLevel(debugLevel)
-        fHandle.setFormatter(logFmt)
-        logger.addHandler(fHandle)
+    logger.info("Starting novelWriter %s (%s) %s" % (
+        __version__, __hexversion__, __date__
+    ))
 
-    if toStd:
-        cHandle = logging.StreamHandler()
-        cHandle.setLevel(debugLevel)
-        cHandle.setFormatter(logFmt)
-        logger.addHandler(cHandle)
+    # Check Packages and Versions
+    errorData = []
+    errorCode = 0
+    if sys.hexversion < 0x030600f0:
+        errorData.append(
+            "At least Python 3.6.0 is required, found %s." % CONFIG.verPyString
+        )
+        errorCode |= 4
+    if CONFIG.verQtValue < 50300:
+        errorData.append(
+            "At least Qt5 version 5.3 is required, found %s." % CONFIG.verQtString
+        )
+        errorCode |= 8
+    if CONFIG.verPyQtValue < 50300:
+        errorData.append(
+            "At least PyQt5 version 5.3 is required, found %s." % CONFIG.verPyQtString
+        )
+        errorCode |= 16
 
-    logger.setLevel(debugLevel)
+    try:
+        import lxml # noqa: F401
+    except ImportError:
+        errorData.append("Python module 'lxml' is missing.")
+        errorCode |= 32
 
-    CONFIG.initConfig(confPath)
+    if errorData:
+        errApp = QApplication([])
+        errMsg = QErrorMessage()
+        errMsg.resize(500, 300)
+        errMsg.showMessage((
+            "<h3>A critical error has been encountered</h3>"
+            "<p>novelWriter cannot start due to the following issues:<p>"
+            "<p>&nbsp;-&nbsp;%s</p>"
+            "<p>Shutting down ...</p>"
+        ) % (
+            "<br>&nbsp;-&nbsp;".join(errorData)
+        ))
+        for errMsg in errorData:
+            logger.critical(errMsg)
+        errApp.exec_()
+        sys.exit(errorCode)
 
+    # Finish initialising config
+    CONFIG.initConfig(confPath, dataPath)
+
+    if CONFIG.osDarwin:
+        try:
+            from Foundation import NSBundle
+            bundle = NSBundle.mainBundle()
+            info = bundle.localizedInfoDictionary() or bundle.infoDictionary()
+            info["CFBundleName"] = "novelWriter"
+        except ImportError:
+            logger.error("Failed to set application name")
+            logException()
+
+    # Import GUI (after dependency checks), and launch
+    from nw.guimain import GuiMain
     if testMode:
         nwGUI = GuiMain()
         return nwGUI
+
     else:
-        nwApp = QApplication([__package__,("-style=%s" % qtStyle)])
+        nwApp = QApplication([CONFIG.appName, ("-style=%s" % qtStyle)])
+        nwApp.setApplicationName(CONFIG.appName)
+        nwApp.setApplicationVersion(__version__)
+        nwApp.setWindowIcon(QIcon(CONFIG.appIcon))
+        nwApp.setOrganizationDomain(__domain__)
+
+        # Connect the exception handler before making the main GUI
+        sys.excepthook = exceptionHandler
+
+        # Launch main GUI
+        CONFIG.initLocalisation(nwApp)
         nwGUI = GuiMain()
+        if not nwGUI.hasProject:
+            nwGUI.showProjectLoadDialog()
+        nwGUI.releaseNotes()
+
         sys.exit(nwApp.exec_())
 
-    return
+# END Function main

nw/assets/dict/README.md

@@ -0,0 +1,12 @@
+## Dictionary Conversion
+
+Source: https://ftp.gnu.org/gnu/aspell/dict/0index.html
+
+```
+./configure
+make
+
+aspell --dict-dir=. -d en dump master > en.dict
+aspell --dict-dir=. -d en_GB-ise-w_accents dump master > en_GB.dict
+aspell --dict-dir=. -d en_US-w_accents dump master > en_US.dict
+```

nw/assets/dict/copyright.txt

@@ -0,0 +1,254 @@
+This English word list is comes directly from SCOWL 2019.10.06 (up to level 60,
+using the speller/make-aspell-dict script, http://wordlist.sourceforge.net/) 
+and is thus under the same copyright of SCOWL.  The affix file (only
+included in the aspell6 package) is based on the Ispell one which is
+under the same copyright of Ispell.  Part of SCOWL is also based on
+Ispell thus the Ispell copyright is included with the SCOWL copyright.
+The collective work is Copyright 2000-2018 by Kevin Atkinson as well
+as any of the copyrights mentioned below:
+
+  Copyright 2000-2018 by Kevin Atkinson
+
+  Permission to use, copy, modify, distribute and sell these word
+  lists, the associated scripts, the output created from the scripts,
+  and its documentation for any purpose is hereby granted without fee,
+  provided that the above copyright notice appears in all copies and
+  that both that copyright notice and this permission notice appear in
+  supporting documentation. Kevin Atkinson makes no representations
+  about the suitability of this array for any purpose. It is provided
+  "as is" without express or implied warranty.
+
+Alan Beale <biljir@pobox.com> also deserves special credit as he has,
+in addition to providing the 12Dicts package and being a major
+contributor to the ENABLE word list, given me an incredible amount of
+feedback and created a number of special lists (those found in the
+Supplement) in order to help improve the overall quality of SCOWL.
+
+The 10 level includes the 1000 most common English words (according to
+the Moby (TM) Words II [MWords] package), a subset of the 1000 most
+common words on the Internet (again, according to Moby Words II), and
+frequently class 16 from Brian Kelk's "UK English Wordlist
+with Frequency Classification".
+
+The MWords package was explicitly placed in the public domain:
+
+    The Moby lexicon project is complete and has
+    been place into the public domain. Use, sell,
+    rework, excerpt and use in any way on any platform.
+
+    Placing this material on internal or public servers is
+    also encouraged. The compiler is not aware of any
+    export restrictions so freely distribute world-wide.
+
+    You can verify the public domain status by contacting
+
+    Grady Ward
+    3449 Martha Ct.
+    Arcata, CA  95521-4884
+
+    grady@netcom.com
+    grady@northcoast.com
+
+The "UK English Wordlist With Frequency Classification" is also in the
+Public Domain:
+
+  Date: Sat, 08 Jul 2000 20:27:21 +0100
+  From: Brian Kelk <Brian.Kelk@cl.cam.ac.uk>
+
+  > I was wondering what the copyright status of your "UK English
+  > Wordlist With Frequency Classification" word list as it seems to
+  > be lacking any copyright notice.
+
+  There were many many sources in total, but any text marked
+  "copyright" was avoided. Locally-written documentation was one
+  source. An earlier version of the list resided in a filespace called
+  PUBLIC on the University mainframe, because it was considered public
+  domain.
+
+  Date: Tue, 11 Jul 2000 19:31:34 +0100
+
+  > So are you saying your word list is also in the public domain?
+
+  That is the intention.
+
+The 20 level includes frequency classes 7-15 from Brian's word list.
+
+The 35 level includes frequency classes 2-6 and words appearing in at
+least 11 of 12 dictionaries as indicated in the 12Dicts package.  All
+words from the 12Dicts package have had likely inflections added via
+my inflection database.
+
+The 12Dicts package and Supplement is in the Public Domain.
+
+The WordNet database, which was used in the creation of the
+Inflections database, is under the following copyright:
+
+  This software and database is being provided to you, the LICENSEE,
+  by Princeton University under the following license.  By obtaining,
+  using and/or copying this software and database, you agree that you
+  have read, understood, and will comply with these terms and
+  conditions.:
+
+  Permission to use, copy, modify and distribute this software and
+  database and its documentation for any purpose and without fee or
+  royalty is hereby granted, provided that you agree to comply with
+  the following copyright notice and statements, including the
+  disclaimer, and that the same appear on ALL copies of the software,
+  database and documentation, including modifications that you make
+  for internal use or for distribution.
+
+  WordNet 1.6 Copyright 1997 by Princeton University.  All rights
+  reserved.
+
+  THIS SOFTWARE AND DATABASE IS PROVIDED "AS IS" AND PRINCETON
+  UNIVERSITY MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+  IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PRINCETON
+  UNIVERSITY MAKES NO REPRESENTATIONS OR WARRANTIES OF MERCHANT-
+  ABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE
+  LICENSED SOFTWARE, DATABASE OR DOCUMENTATION WILL NOT INFRINGE ANY
+  THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
+
+  The name of Princeton University or Princeton may not be used in
+  advertising or publicity pertaining to distribution of the software
+  and/or database.  Title to copyright in this software, database and
+  any associated documentation shall at all times remain with
+  Princeton University and LICENSEE agrees to preserve same.
+
+The 40 level includes words from Alan's 3esl list found in version 4.0
+of his 12dicts package.  Like his other stuff the 3esl list is also in the
+public domain.
+
+The 50 level includes Brian's frequency class 1, words appearing
+in at least 5 of 12 of the dictionaries as indicated in the 12Dicts
+package, and uppercase words in at least 4 of the previous 12
+dictionaries.  A decent number of proper names is also included: The
+top 1000 male, female, and Last names from the 1990 Census report; a
+list of names sent to me by Alan Beale; and a few names that I added
+myself.  Finally a small list of abbreviations not commonly found in
+other word lists is included.
+
+The name files form the Census report is a government document which I
+don't think can be copyrighted.
+
+The file special-jargon.50 uses common.lst and word.lst from the
+"Unofficial Jargon File Word Lists" which is derived from "The Jargon
+File".  All of which is in the Public Domain.  This file also contain
+a few extra UNIX terms which are found in the file "unix-terms" in the
+special/ directory.
+
+The 55 level includes words from Alan's 2of4brif list found in version
+4.0 of his 12dicts package.  Like his other stuff the 2of4brif is also
+in the public domain.
+
+The 60 level includes all words appearing in at least 2 of the 12
+dictionaries as indicated by the 12Dicts package.
+
+The 70 level includes Brian's frequency class 0 and the 74,550 common
+dictionary words from the MWords package.  The common dictionary words,
+like those from the 12Dicts package, have had all likely inflections
+added.  The 70 level also included the 5desk list from version 4.0 of
+the 12Dics package which is in the public domain.
+
+The 80 level includes the ENABLE word list, all the lists in the
+ENABLE supplement package (except for ABLE), the "UK Advanced Cryptics
+Dictionary" (UKACD), the list of signature words from the YAWL package,
+and the 10,196 places list from the MWords package.
+
+The ENABLE package, mainted by M\Cooper <thegrendel@theriver.com>,
+is in the Public Domain:
+
+  The ENABLE master word list, WORD.LST, is herewith formally released
+  into the Public Domain. Anyone is free to use it or distribute it in
+  any manner they see fit. No fee or registration is required for its
+  use nor are "contributions" solicited (if you feel you absolutely
+  must contribute something for your own peace of mind, the authors of
+  the ENABLE list ask that you make a donation on their behalf to your
+  favorite charity). This word list is our gift to the Scrabble
+  community, as an alternate to "official" word lists. Game designers
+  may feel free to incorporate the WORD.LST into their games. Please
+  mention the source and credit us as originators of the list. Note
+  that if you, as a game designer, use the WORD.LST in your product,
+  you may still copyright and protect your product, but you may *not*
+  legally copyright or in any way restrict redistribution of the
+  WORD.LST portion of your product. This *may* under law restrict your
+  rights to restrict your users' rights, but that is only fair.
+
+UKACD, by J Ross Beresford <ross@bryson.demon.co.uk>, is under the
+following copyright:
+
+  Copyright (c) J Ross Beresford 1993-1999. All Rights Reserved.
+
+  The following restriction is placed on the use of this publication:
+  if The UK Advanced Cryptics Dictionary is used in a software package
+  or redistributed in any form, the copyright notice must be
+  prominently displayed and the text of this document must be included
+  verbatim.
+
+  There are no other restrictions: I would like to see the list
+  distributed as widely as possible.
+
+The 95 level includes the 354,984 single words, 256,772 compound
+words, 4,946 female names and the 3,897 male names, and 21,986 names
+from the MWords package, ABLE.LST from the ENABLE Supplement, and some
+additional words found in my part-of-speech database that were not
+found anywhere else.
+
+Accent information was taken from UKACD.
+
+The VarCon package was used to create the American, British, Canadian,
+and Australian word list.  It is under the following copyright:
+
+  Copyright 2000-2016 by Kevin Atkinson
+
+  Permission to use, copy, modify, distribute and sell this array, the
+  associated software, and its documentation for any purpose is hereby
+  granted without fee, provided that the above copyright notice appears
+  in all copies and that both that copyright notice and this permission
+  notice appear in supporting documentation. Kevin Atkinson makes no
+  representations about the suitability of this array for any
+  purpose. It is provided "as is" without express or implied warranty.
+
+  Copyright 2016 by Benjamin Titze
+
+  Permission to use, copy, modify, distribute and sell this array, the
+  associated software, and its documentation for any purpose is hereby
+  granted without fee, provided that the above copyright notice appears
+  in all copies and that both that copyright notice and this permission
+  notice appear in supporting documentation. Benjamin Titze makes no
+  representations about the suitability of this array for any
+  purpose. It is provided "as is" without express or implied warranty.
+
+  Since the original words lists come from the Ispell distribution:
+
+  Copyright 1993, Geoff Kuenning, Granada Hills, CA
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions
+  are met:
+
+  1. Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+  3. All modifications to the source code must be clearly marked as
+     such.  Binary redistributions based on modified source code
+     must be clearly marked as modified versions in the documentation
+     and/or other materials provided with the distribution.
+  (clause 4 removed with permission from Geoff Kuenning)
+  5. The name of Geoff Kuenning may not be used to endorse or promote
+     products derived from this software without specific prior
+     written permission.
+
+  THIS SOFTWARE IS PROVIDED BY GEOFF KUENNING AND CONTRIBUTORS ``AS IS'' AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+  ARE DISCLAIMED.  IN NO EVENT SHALL GEOFF KUENNING OR CONTRIBUTORS BE LIABLE
+  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+  SUCH DAMAGE.

nw/assets/fonts/Cantarell/OFL.txt

@@ -0,0 +1,93 @@
+Copyright (c) 2009-2010, Understanding Limited (dave@understandinglimited.com)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

nw/assets/i18n/project_de.json

@@ -0,0 +1,105 @@
+{
+  "Synopsis": "Synopsis",
+  "Comment": "Kommentar",
+  "Notes": "Notizen",
+  "0": "Null",
+  "1": "Eins",
+  "2": "Zwei",
+  "3": "Drei",
+  "4": "Vier",
+  "5": "Fünf",
+  "6": "Sechs",
+  "7": "Sieben",
+  "8": "Acht",
+  "9": "Neun",
+  "10": "Zehn",
+  "11": "Elf",
+  "12": "Zwölf",
+  "13": "Dreizehen",
+  "14": "Vierzehn",
+  "15": "Fünfzehn",
+  "16": "Sechzehn",
+  "17": "Siebzehn",
+  "18": "Achtzehn",
+  "19": "Neunzehn",
+  "20": "Zwanzig",
+  "21": "Einundzwanzig",
+  "22": "Zweiundzwanzig",
+  "23": "Dreiundzwanzig",
+  "24": "Vierundzwanzig",
+  "25": "Fünfundzwanzig",
+  "26": "Sechsundzwanzig",
+  "27": "Siebenundzwanzig",
+  "28": "Achtundzwanzig",
+  "29": "Neunundzwanzig",
+  "30": "Dreißig",
+  "31": "Einunddreißig",
+  "32": "Zweiunddreißig",
+  "33": "Dreiunddreißig",
+  "34": "Vierunddreißig",
+  "35": "Fünfunddreißig",
+  "36": "Sechsunddreißig",
+  "37": "Siebenunddreißig",
+  "38": "Achtunddreißig",
+  "39": "Neununddreißig",
+  "40": "Vierzig",
+  "41": "Einundvierzig",
+  "42": "Zweiundvierzig",
+  "43": "Dreiundvierzig",
+  "44": "Vierundvierzig",
+  "45": "Fünfundvierzig",
+  "46": "Sechsundvierzig",
+  "47": "Siebenundvierzig",
+  "48": "Achtundvierzig",
+  "49": "Neunundvierzig",
+  "50": "Fünfzig",
+  "51": "Einundfünfzig",
+  "52": "Zweiundfünfzig",
+  "53": "Dreiundfünfzig",
+  "54": "Vierundfünfzig",
+  "55": "Fünfundfünfzig",
+  "56": "Sechsundfünfzig",
+  "57": "Siebenundfünfzig",
+  "58": "Achtundfünfzig",
+  "59": "Neunundfünfzig",
+  "60": "Sechzig",
+  "61": "Einundsechzig",
+  "62": "Zweiundsechzig",
+  "63": "Dreiundsechzig",
+  "64": "Vierundsechzig",
+  "65": "Fünfundsechzig",
+  "66": "Sechsundsechzig",
+  "67": "Siebenundsechzig",
+  "68": "Achtundsechzig",
+  "69": "Neunundsechzig",
+  "70": "Siebzig",
+  "71": "Einundsiebzig",
+  "72": "Zweiundsiebzig",
+  "73": "Dreiundsiebzig",
+  "74": "Vierundsiebzig",
+  "75": "Fünfundsiebzig",
+  "76": "Sechsundsiebzig",
+  "77": "Siebenundsiebzig",
+  "78": "Achtundsiebzig",
+  "79": "Neunundsiebzig",
+  "80": "Achtzig",
+  "81": "Einundachtzig",
+  "82": "Zweiundachtzig",
+  "83": "Dreiundachtzig",
+  "84": "Vierundachtzig",
+  "85": "Fünfundachtzig",
+  "86": "Sechsundachtzig",
+  "87": "Siebenundachtzig",
+  "88": "Achtundachtzig",
+  "89": "Neunundachtzig",
+  "90": "Neunzig",
+  "91": "Einundneunzig",
+  "92": "Zweiundneunzig",
+  "93": "Dreiundneunzig",
+  "94": "Vierundneunzig",
+  "95": "Fünfundneunzig",
+  "96": "Sechsundneunzig",
+  "97": "Siebenundneunzig",
+  "98": "Achtundneunzig",
+  "99": "Neunundneunzig"
+}

nw/assets/i18n/project_en.json

@@ -0,0 +1,105 @@
+{
+  "Synopsis": "Synopsis",
+  "Comment": "Comment",
+  "Notes": "Notes",
+  "0": "Zero",
+  "1": "One",
+  "2": "Two",
+  "3": "Three",
+  "4": "Four",
+  "5": "Five",
+  "6": "Six",
+  "7": "Seven",
+  "8": "Eight",
+  "9": "Nine",
+  "10": "Ten",
+  "11": "Eleven",
+  "12": "Twelve",
+  "13": "Thirteen",
+  "14": "Fourteen",
+  "15": "Fifteen",
+  "16": "Sixteen",
+  "17": "Seventeen",
+  "18": "Eighteen",
+  "19": "Nineteen",
+  "20": "Twenty",
+  "21": "Twenty-One",
+  "22": "Twenty-Two",
+  "23": "Twenty-Three",
+  "24": "Twenty-Four",
+  "25": "Twenty-Five",
+  "26": "Twenty-Six",
+  "27": "Twenty-Seven",
+  "28": "Twenty-Eight",
+  "29": "Twenty-Nine",
+  "30": "Thirty",
+  "31": "Thirty-One",
+  "32": "Thirty-Two",
+  "33": "Thirty-Three",
+  "34": "Thirty-Four",
+  "35": "Thirty-Five",
+  "36": "Thirty-Six",
+  "37": "Thirty-Seven",
+  "38": "Thirty-Eight",
+  "39": "Thirty-Nine",
+  "40": "Forty",
+  "41": "Forty-One",
+  "42": "Forty-Two",
+  "43": "Forty-Three",
+  "44": "Forty-Four",
+  "45": "Forty-Five",
+  "46": "Forty-Six",
+  "47": "Forty-Seven",
+  "48": "Forty-Eight",
+  "49": "Forty-Nine",
+  "50": "Fifty",
+  "51": "Fifty-One",
+  "52": "Fifty-Two",
+  "53": "Fifty-Three",
+  "54": "Fifty-Four",
+  "55": "Fifty-Five",
+  "56": "Fifty-Six",
+  "57": "Fifty-Seven",
+  "58": "Fifty-Eight",
+  "59": "Fifty-Nine",
+  "60": "Sixty",
+  "61": "Sixty-One",
+  "62": "Sixty-Two",
+  "63": "Sixty-Three",
+  "64": "Sixty-Four",
+  "65": "Sixty-Five",
+  "66": "Sixty-Six",
+  "67": "Sixty-Seven",
+  "68": "Sixty-Eight",
+  "69": "Sixty-Nine",
+  "70": "Seventy",
+  "71": "Seventy-One",
+  "72": "Seventy-Two",
+  "73": "Seventy-Three",
+  "74": "Seventy-Four",
+  "75": "Seventy-Five",
+  "76": "Seventy-Six",
+  "77": "Seventy-Seven",
+  "78": "Seventy-Eight",
+  "79": "Seventy-Nine",
+  "80": "Eighty",
+  "81": "Eighty-One",
+  "82": "Eighty-Two",
+  "83": "Eighty-Three",
+  "84": "Eighty-Four",
+  "85": "Eighty-Five",
+  "86": "Eighty-Six",
+  "87": "Eighty-Seven",
+  "88": "Eighty-Eight",
+  "89": "Eighty-Nine",
+  "90": "Ninety",
+  "91": "Ninety-One",
+  "92": "Ninety-Two",
+  "93": "Ninety-Three",
+  "94": "Ninety-Four",
+  "95": "Ninety-Five",
+  "96": "Ninety-Six",
+  "97": "Ninety-Seven",
+  "98": "Ninety-Eight",
+  "99": "Ninety-Nine"
+}

nw/assets/i18n/project_fr.json

@@ -0,0 +1,105 @@
+{
+  "Synopsis": "Synopsis",
+  "Comment": "Commentaire",
+  "Notes": "Notes",
+  "0": "Zero",
+  "1": "Un",
+  "2": "Deux",
+  "3": "Trois",
+  "4": "Quatre",
+  "5": "Cinq",
+  "6": "Six",
+  "7": "Sept",
+  "8": "Huit",
+  "9": "Neuf",
+  "10": "Dix",
+  "11": "Onze",
+  "12": "Douze",
+  "13": "Treize",
+  "14": "Quatorze",
+  "15": "Quinze",
+  "16": "Seize",
+  "17": "Dix-sept",
+  "18": "Dix-huit",
+  "19": "Dix-neuf",
+  "20": "Vingt",
+  "21": "Vingt et un",
+  "22": "Vingt-deux",
+  "23": "Vingt-trois",
+  "24": "Vingt-quatre",
+  "25": "Vingt-cinq",
+  "26": "Vingt-six",
+  "27": "Vingt-sept",
+  "28": "Vingt-huit",
+  "29": "Vingt-neuf",
+  "30": "Trente",
+  "31": "Trente et un",
+  "32": "Trente-deux",
+  "33": "Trente-trois",
+  "34": "Trente-quatre",
+  "35": "Trente-cinq",
+  "36": "Trente-six",
+  "37": "Trente-sept",
+  "38": "Trente-huit",
+  "39": "Trente-neuf",
+  "40": "Quarante",
+  "41": "Quarante et un",
+  "42": "Quarante-deux",
+  "43": "Quarante-trois",
+  "44": "Quarante-quatre",
+  "45": "Quarante-cinq",
+  "46": "Quarante-six",
+  "47": "Quarante-sept",
+  "48": "Quarante-huit",
+  "49": "Quarante-neuf",
+  "50": "Cinquante",
+  "51": "Cinquante et un",
+  "52": "Cinquante-deux",
+  "53": "Cinquante-trois",
+  "54": "Cinquante-quatre",
+  "55": "Cinquante-cinq",
+  "56": "Cinquante-six",
+  "57": "Cinquante-sept",
+  "58": "Cinquante-huit",
+  "59": "Cinquante-neuf",
+  "60": "Soixante",
+  "61": "Soixante et un",
+  "62": "Soixante-deux",
+  "63": "Soixante-trois",
+  "64": "Soixante-quatre",
+  "65": "Soixante-cinq",
+  "66": "Soixante-six",
+  "67": "Soixante-sept",
+  "68": "Soixante-huit",
+  "69": "Soixante-neuf",
+  "70": "Soixante-dix",
+  "71": "Soixante et onze",
+  "72": "Soixante-douze",
+  "73": "Soixante-treize",
+  "74": "Soixante-quatorze",
+  "75": "Soixante-quinze",
+  "76": "Soixante-seize",
+  "77": "Soixante-dix-sept",
+  "78": "Soixante-dix-huit",
+  "79": "Soixante-dix-neuf",
+  "80": "Quatre-vingts",
+  "81": "Quatre-vingt-un",
+  "82": "Quatre-vingt-deux",
+  "83": "Quatre-vingt-trois",
+  "84": "Quatre-vingt-quatre",
+  "85": "Quatre-vingt-cinq",
+  "86": "Quatre-vingt-six",
+  "87": "Quatre-vingt-sept",
+  "88": "Quatre-vingt-huit",
+  "89": "Quatre-vingt-neuf",
+  "90": "Quatre-vingt-dix",
+  "91": "Quatre-vingt-onze",
+  "92": "Quatre-vingt-douze",
+  "93": "Quatre-vingt-treize",
+  "94": "Quatre-vingt-quatorze",
+  "95": "Quatre-vingt-quinze",
+  "96": "Quatre-vingt-seize",
+  "97": "Quatre-vingt-dix-sept",
+  "98": "Quatre-vingt-dix-huit",
+  "99": "Quatre-vingt-dix-neuf"
+}

nw/assets/i18n/project_nb_NO.json

@@ -0,0 +1,105 @@
+{
+  "Synopsis": "Sammendrag",
+  "Comment": "Kommentar",
+  "Notes": "Notat",
+  "0": "null",
+  "1": "én",
+  "2": "to",
+  "3": "tre",
+  "4": "fire",
+  "5": "fem",
+  "6": "seks",
+  "7": "sju",
+  "8": "åtte",
+  "9": "ni",
+  "10": "ti",
+  "11": "elleve",
+  "12": "tolv",
+  "13": "tretten",
+  "14": "fjorten",
+  "15": "femten",
+  "16": "seksten",
+  "17": "sytten",
+  "18": "atten",
+  "19": "nitten",
+  "20": "tjue",
+  "21": "tjueén",
+  "22": "tjueto",
+  "23": "tjuetre",
+  "24": "tjuefire",
+  "25": "tjuefem",
+  "26": "tjueseks",
+  "27": "tjuesju",
+  "28": "tjueåtte",
+  "29": "tjueni",
+  "30": "tretti",
+  "31": "trettién",
+  "32": "trettito",
+  "33": "trettitre",
+  "34": "trettifire",
+  "35": "trettifem",
+  "36": "trettiseks",
+  "37": "trettisju",
+  "38": "trettiåtte",
+  "39": "trettini",
+  "40": "førti",
+  "41": "førtién",
+  "42": "førtito",
+  "43": "førtitre",
+  "44": "førtifire",
+  "45": "førtifem",
+  "46": "førtiseks",
+  "47": "førtisju",
+  "48": "førtiåtte",
+  "49": "førtini",
+  "50": "femti",
+  "51": "femtién",
+  "52": "femtito",
+  "53": "femtitre",
+  "54": "femtifire",
+  "55": "femtifem",
+  "56": "femtiseks",
+  "57": "femtisju",
+  "58": "femtiåtte",
+  "59": "femtini",
+  "60": "seksti",
+  "61": "sekstién",
+  "62": "sekstito",
+  "63": "sekstitre",
+  "64": "sekstifire",
+  "65": "sekstifem",
+  "66": "sekstiseks",
+  "67": "sekstisju",
+  "68": "sekstiåtte",
+  "69": "sekstini",
+  "70": "sytti",
+  "71": "syttién",
+  "72": "syttito",
+  "73": "syttitre",
+  "74": "syttifire",
+  "75": "syttifem",
+  "76": "syttiseks",
+  "77": "syttisju",
+  "78": "syttiåtte",
+  "79": "syttini",
+  "80": "åtti",
+  "81": "åttién",
+  "82": "åttito",
+  "83": "åttitre",
+  "84": "åttifire",
+  "85": "åttifem",
+  "86": "åttiseks",
+  "87": "åttisju",
+  "88": "åttiåtte",
+  "89": "åttini",
+  "90": "nitti",
+  "91": "nittién",
+  "92": "nittito",
+  "93": "nittitre",
+  "94": "nittifire",
+  "95": "nittifem",
+  "96": "nittiseks",
+  "97": "nittisju",
+  "98": "nittiåtte",
+  "99": "nittini"
+}

nw/assets/i18n/project_nn_NO.json

@@ -0,0 +1,105 @@
+{
+  "Synopsis": "Samandrag",
+  "Comment": "Kommentar",
+  "Notes": "Notat",
+  "0": "null",
+  "1": "ein",
+  "2": "to",
+  "3": "tre",
+  "4": "fire",
+  "5": "fem",
+  "6": "seks",
+  "7": "sju",
+  "8": "åtte",
+  "9": "ni",
+  "10": "ti",
+  "11": "elleve",
+  "12": "tolv",
+  "13": "tretten",
+  "14": "fjorten",
+  "15": "femten",
+  "16": "seksten",
+  "17": "sytten",
+  "18": "atten",
+  "19": "nitten",
+  "20": "tjue",
+  "21": "tjueein",
+  "22": "tjueto",
+  "23": "tjuetre",
+  "24": "tjuefire",
+  "25": "tjuefem",
+  "26": "tjueseks",
+  "27": "tjuesju",
+  "28": "tjueåtte",
+  "29": "tjueni",
+  "30": "tretti",
+  "31": "trettiein",
+  "32": "trettito",
+  "33": "trettitre",
+  "34": "trettifire",
+  "35": "trettifem",
+  "36": "trettiseks",
+  "37": "trettisju",
+  "38": "trettiåtte",
+  "39": "trettini",
+  "40": "førti",
+  "41": "førtiein",
+  "42": "førtito",
+  "43": "førtitre",
+  "44": "førtifire",
+  "45": "førtifem",
+  "46": "førtiseks",
+  "47": "førtisju",
+  "48": "førtiåtte",
+  "49": "førtini",
+  "50": "femti",
+  "51": "femtiein",
+  "52": "femtito",
+  "53": "femtitre",
+  "54": "femtifire",
+  "55": "femtifem",
+  "56": "femtiseks",
+  "57": "femtisju",
+  "58": "femtiåtte",
+  "59": "femtini",
+  "60": "seksti",
+  "61": "sekstiein",
+  "62": "sekstito",
+  "63": "sekstitre",
+  "64": "sekstifire",
+  "65": "sekstifem",
+  "66": "sekstiseks",
+  "67": "sekstisju",
+  "68": "sekstiåtte",
+  "69": "sekstini",
+  "70": "sytti",
+  "71": "syttiein",
+  "72": "syttito",
+  "73": "syttitre",
+  "74": "syttifire",
+  "75": "syttifem",
+  "76": "syttiseks",
+  "77": "syttisju",
+  "78": "syttiåtte",
+  "79": "syttini",
+  "80": "åtti",
+  "81": "åttiein",
+  "82": "åttito",
+  "83": "åttitre",
+  "84": "åttifire",
+  "85": "åttifem",
+  "86": "åttiseks",
+  "87": "åttisju",
+  "88": "åttiåtte",
+  "89": "åttini",
+  "90": "nitti",
+  "91": "nittiein",
+  "92": "nittito",
+  "93": "nittitre",
+  "94": "nittifire",
+  "95": "nittifem",
+  "96": "nittiseks",
+  "97": "nittisju",
+  "98": "nittiåtte",
+  "99": "nittini"
+}

nw/assets/i18n/project_pt.json

@@ -0,0 +1,105 @@
+{
+  "Synopsis": "Sinopse",
+  "Comment": "Comentários",
+  "Notes": "Notas",
+  "0": "Zero",
+  "1": "Um",
+  "2": "Dois",
+  "3": "Três",
+  "4": "Quatro",
+  "5": "Cinco",
+  "6": "Seis",
+  "7": "Sete",
+  "8": "Oito",
+  "9": "Nove",
+  "10": "Dez",
+  "11": "Onze",
+  "12": "Doze",
+  "13": "Treze",
+  "14": "Quatorze",
+  "15": "Quinze",
+  "16": "Dezesseis",
+  "17": "Dezesete",
+  "18": "Dezoito",
+  "19": "Dezenove",
+  "20": "Vinte",
+  "21": "Vinte e Um",
+  "22": "Vinte e Dois",
+  "23": "Vinte e Três",
+  "24": "Vinte e Quatro",
+  "25": "Vinte e Cinco",
+  "26": "Vinte e Seis",
+  "27": "Vinte e Sete",
+  "28": "Vinte e Oito",
+  "29": "Vinte e Nove",
+  "30": "Trinta",
+  "31": "Trinta e Um",
+  "32": "Trinta e Dois",
+  "33": "Trinta e Três",
+  "34": "Trinta e Quatro",
+  "35": "Trinta e Cinco",
+  "36": "Trinta e Seis",
+  "37": "Trinta e Sete",
+  "38": "Trinta e Oito",
+  "39": "Trinta e Nove",
+  "40": "Quarenta",
+  "41": "Quarenta e Um",
+  "42": "Quarenta e Dois",
+  "43": "Quarenta e Três",
+  "44": "Quarenta e Quatro",
+  "45": "Quarenta e Cinco",
+  "46": "Quarenta e Seis",
+  "47": "Quarenta e Sete",
+  "48": "Quarenta e Oito",
+  "49": "Quarenta e Nove",
+  "50": "Cinquenta",
+  "51": "Cinquenta e Um",
+  "52": "Cinquenta e Dois",
+  "53": "Cinquenta e Três",
+  "54": "Cinquenta e Quatro",
+  "55": "Cinquenta e Cinco",
+  "56": "Cinquenta e Seis",
+  "57": "Cinquenta e Sete",
+  "58": "Cinquenta e Oito",
+  "59": "Cinquenta e Nove",
+  "60": "Sessenta",
+  "61": "Sessenta e Um",
+  "62": "Sessenta e Dois",
+  "63": "Sessenta e Três",
+  "64": "Sessenta e Quatro",
+  "65": "Sessenta e Cinco",
+  "66": "Sessenta e Seis",
+  "67": "Sessenta e Sete",
+  "68": "Sessenta e Oito",
+  "69": "Sessenta e Nove",
+  "70": "Setenta",
+  "71": "Setenta e Um",
+  "72": "Setenta e Dois",
+  "73": "Setenta e Três",
+  "74": "Setenta e Quatro",
+  "75": "Setenta e Cinco",
+  "76": "Setenta e Seis",
+  "77": "Setenta e Sete",
+  "78": "Setenta e Oito",
+  "79": "Setenta e Nove",
+  "80": "Oitenta",
+  "81": "Oitenta e Um",
+  "82": "Oitenta e Dois",
+  "83": "Oitenta e Três",
+  "84": "Oitenta e Quatro",
+  "85": "Oitenta e Cinco",
+  "86": "Oitenta e Seis",
+  "87": "Oitenta e Sete",
+  "88": "Oitenta e Oito",
+  "89": "Oitenta e Nove",
+  "90": "Noventa",
+  "91": "Noventa e Um",
+  "92": "Noventa e Dois",
+  "93": "Noventa e Três",
+  "94": "Noventa e Quatro",
+  "95": "Noventa e Cinco",
+  "96": "Noventa e Seis",
+  "97": "Noventa e Sete",
+  "98": "Noventa e Oito",
+  "99": "Noventa e Nove"
+}

nw/assets/icons/fallback/README.md

@@ -0,0 +1,6 @@
+## License
+
+All icons in the fallback folder are modified from the Typicons theme by
+Stephen Hutchings, released under CC BY-SA 4.0.
+
+See: https://github.com/stephenhutchings/typicons.font

nw/assets/icons/fallback/add-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg5808"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata5814">
+    <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>
+  <defs
+     id="defs5812" />
+  <path
+     style="stroke-width:1.25;fill:#aeaeae;fill-opacity:1"
+     id="path5806"
+     d="m 19.5,9.5 h -5 v -5 C 14.5,3.12 13.38,2 12,2 10.62,2 9.5,3.12 9.5,4.5 l 0.08875,5 H 4.5 C 3.12,9.5 2,10.62 2,12 c 0,1.38 1.12,2.5 2.5,2.5 L 9.58875,14.41125 9.5,19.5 c 0,1.38 1.12,2.5 2.5,2.5 1.38,0 2.5,-1.12 2.5,-2.5 V 14.41125 L 19.5,14.5 C 20.88,14.5 22,13.38 22,12 22,10.62 20.88,9.5 19.5,9.5 Z" />
+</svg>

nw/assets/icons/fallback/add.svg

@@ -0,0 +1,31 @@
+<?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"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg5808">
+  <metadata
+     id="metadata5814">
+    <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>
+  <defs
+     id="defs5812" />
+  <path
+     d="m 19.5,9.5 h -5 v -5 C 14.5,3.12 13.38,2 12,2 10.62,2 9.5,3.12 9.5,4.5 l 0.08875,5 H 4.5 C 3.12,9.5 2,10.62 2,12 c 0,1.38 1.12,2.5 2.5,2.5 L 9.58875,14.41125 9.5,19.5 c 0,1.38 1.12,2.5 2.5,2.5 1.38,0 2.5,-1.12 2.5,-2.5 V 14.41125 L 19.5,14.5 C 20.88,14.5 22,13.38 22,12 22,10.62 20.88,9.5 19.5,9.5 Z"
+     id="path5806"
+     style="stroke-width:1.25;fill:#000000;fill-opacity:0.77999997" />
+</svg>

nw/assets/icons/fallback/backward-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg8980"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata8986">
+    <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>
+  <defs
+     id="defs8984" />
+  <path
+     style="fill:#aeaeae;fill-opacity:1;stroke-width:1.28574"
+     id="path8978"
+     d="m 17.565474,3.7531206 c -1.002875,-1.0041608 -2.63319,-1.0041608 -3.636065,0 L 5.6814051,11.999839 13.929409,20.246558 C 14.430847,20.749281 15.089144,21 15.747442,21 c 0.658297,0 1.316595,-0.250719 1.818032,-0.753442 1.004161,-1.004161 1.004161,-2.631904 0,-3.636065 l -4.609368,-4.610654 4.609368,-4.6106535 c 1.004161,-1.0041608 1.004161,-2.6319041 0,-3.6360649 z" />
+</svg>

nw/assets/icons/fallback/backward.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg8980"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata8986">
+    <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>
+  <defs
+     id="defs8984" />
+  <path
+     style="fill:#000000;fill-opacity:0.78;stroke-width:1.28574"
+     id="path8978"
+     d="m 17.565474,3.7531206 c -1.002875,-1.0041608 -2.63319,-1.0041608 -3.636065,0 L 5.6814051,11.999839 13.929409,20.246558 C 14.430847,20.749281 15.089144,21 15.747442,21 c 0.658297,0 1.316595,-0.250719 1.818032,-0.753442 1.004161,-1.004161 1.004161,-2.631904 0,-3.636065 l -4.609368,-4.610654 4.609368,-4.6106535 c 1.004161,-1.0041608 1.004161,-2.6319041 0,-3.6360649 z" />
+</svg>

nw/assets/icons/fallback/bullet-off-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg11603"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata11609">
+    <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>
+  <defs
+     id="defs11607" />
+  <path
+     style="stroke-width:1.5;fill:#aeaeae;fill-opacity:1"
+     id="path11601"
+     d="m 12,6 c 3.3075,0 6,2.691 6,6 0,3.309 -2.6925,6 -6,6 C 8.6925,18 6,15.309 6,12 6,8.691 8.6925,6 12,6 m 0,-3 c -4.971,0 -9,4.029 -9,9 0,4.968 4.029,9 9,9 4.968,0 9,-4.032 9,-9 0,-4.971 -4.032,-9 -9,-9 z" />
+</svg>

nw/assets/icons/fallback/bullet-off.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg11603"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata11609">
+    <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>
+  <defs
+     id="defs11607" />
+  <path
+     style="stroke-width:1.5;fill:#000000;fill-opacity:0.78039217"
+     id="path11601"
+     d="m 12,6 c 3.3075,0 6,2.691 6,6 0,3.309 -2.6925,6 -6,6 C 8.6925,18 6,15.309 6,12 6,8.691 8.6925,6 12,6 m 0,-3 c -4.971,0 -9,4.029 -9,9 0,4.968 4.029,9 9,9 4.968,0 9,-4.032 9,-9 0,-4.971 -4.032,-9 -9,-9 z" />
+</svg>

nw/assets/icons/fallback/bullet-on-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg10879"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata10885">
+    <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>
+  <defs
+     id="defs10883" />
+  <path
+     style="stroke-width:1.5;fill:#aeaeae;fill-opacity:1"
+     id="path10877"
+     d="M 21,12 C 21,9.5145 19.992,7.2645 18.3645,5.6355 16.7355,4.008 14.4855,3 12,3 9.516,3 7.266,4.008 5.637,5.6355 4.008,7.2645 3,9.5145 3,12 3,14.484 4.008,16.734 5.637,18.363 7.266,19.992 9.516,21 12,21 14.4855,21 16.7355,19.992 18.3645,18.363 19.992,16.734 21,14.484 21,12 Z" />
+</svg>

nw/assets/icons/fallback/bullet-on.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg10879"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata10885">
+    <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>
+  <defs
+     id="defs10883" />
+  <path
+     style="stroke-width:1.5;fill:#000000;fill-opacity:0.78039217"
+     id="path10877"
+     d="M 21,12 C 21,9.5145 19.992,7.2645 18.3645,5.6355 16.7355,4.008 14.4855,3 12,3 9.516,3 7.266,4.008 5.637,5.6355 4.008,7.2645 3,9.5145 3,12 3,14.484 4.008,16.734 5.637,18.363 7.266,19.992 9.516,21 12,21 14.4855,21 16.7355,19.992 18.3645,18.363 19.992,16.734 21,14.484 21,12 Z" />
+</svg>

nw/assets/icons/fallback/check-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg896">
+  <metadata
+     id="metadata902">
+    <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>
+  <defs
+     id="defs900" />
+  <path
+     d="M 19.576035,3.3487939 C 18.237131,2.6038813 16.550693,3.0884898 15.809935,4.4246248 L 10.66893,13.676495 7.726664,10.734229 c -1.0813694,-1.0813704 -2.8342677,-1.0813704 -3.9156371,0 -1.0813693,1.081369 -1.0813693,2.834267 0,3.915637 l 5.538383,5.538383 c 0.523378,0.524762 1.2295221,0.812758 1.9578191,0.812758 l 0.383533,-0.02769 c 0.859834,-0.12046 1.614439,-0.636914 2.03674,-1.397057 L 20.650482,7.1148966 C 21.39401,5.777375 20.91217,4.0923218 19.576035,3.3487939 Z"
+     id="path894"
+     style="stroke-width:1.3846;fill:#aeaeae;fill-opacity:1" />
+</svg>

nw/assets/icons/fallback/check.svg

@@ -0,0 +1,31 @@
+<?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"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg896">
+  <metadata
+     id="metadata902">
+    <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>
+  <defs
+     id="defs900" />
+  <path
+     d="M 19.576035,3.3487939 C 18.237131,2.6038813 16.550693,3.0884898 15.809935,4.4246248 L 10.66893,13.676495 7.726664,10.734229 c -1.0813694,-1.0813704 -2.8342677,-1.0813704 -3.9156371,0 -1.0813693,1.081369 -1.0813693,2.834267 0,3.915637 l 5.538383,5.538383 c 0.523378,0.524762 1.2295221,0.812758 1.9578191,0.812758 l 0.383533,-0.02769 c 0.859834,-0.12046 1.614439,-0.636914 2.03674,-1.397057 L 20.650482,7.1148966 C 21.39401,5.777375 20.91217,4.0923218 19.576035,3.3487939 Z"
+     id="path894"
+     style="stroke-width:1.3846;fill:#000000;fill-opacity:0.77999997" />
+</svg>

nw/assets/icons/fallback/cross-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg8936"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata8942">
+    <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>
+  <defs
+     id="defs8940" />
+  <path
+     style="fill:#aeaeae;fill-opacity:1;stroke-width:1.30056"
+     id="path8934"
+     d="m 19.0412,4.9586375 c -1.014432,-1.0157327 -2.663535,-1.0157327 -3.677967,0 L 12.000001,8.3218703 8.6367669,4.9586375 c -1.0144323,-1.0157327 -2.663535,-1.0157327 -3.6779673,0 -1.0157327,1.0157328 -1.0157327,2.6622343 0,3.6779673 L 8.3207319,11.999838 4.9587996,15.36307 c -1.0157327,1.015733 -1.0157327,2.662235 0,3.677968 0.5072161,0.508516 1.1730998,0.762124 1.8389836,0.762124 0.6658835,0 1.3317669,-0.253608 1.8389837,-0.762124 l 3.3632341,-3.363233 3.363232,3.363233 c 0.507216,0.508516 1.173099,0.762124 1.838984,0.762124 0.665882,0 1.331765,-0.253608 1.838983,-0.762124 1.015733,-1.015733 1.015733,-2.662235 0,-3.677968 L 15.679268,11.999838 19.0412,8.6366048 c 1.015733,-1.015733 1.015733,-2.6622345 0,-3.6779673 z" />
+</svg>

nw/assets/icons/fallback/cross.svg

@@ -0,0 +1,31 @@
+<?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"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg8936">
+  <metadata
+     id="metadata8942">
+    <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>
+  <defs
+     id="defs8940" />
+  <path
+     d="m 19.0412,4.9586375 c -1.014432,-1.0157327 -2.663535,-1.0157327 -3.677967,0 L 12.000001,8.3218703 8.6367669,4.9586375 c -1.0144323,-1.0157327 -2.663535,-1.0157327 -3.6779673,0 -1.0157327,1.0157328 -1.0157327,2.6622343 0,3.6779673 L 8.3207319,11.999838 4.9587996,15.36307 c -1.0157327,1.015733 -1.0157327,2.662235 0,3.677968 0.5072161,0.508516 1.1730998,0.762124 1.8389836,0.762124 0.6658835,0 1.3317669,-0.253608 1.8389837,-0.762124 l 3.3632341,-3.363233 3.363232,3.363233 c 0.507216,0.508516 1.173099,0.762124 1.838984,0.762124 0.665882,0 1.331765,-0.253608 1.838983,-0.762124 1.015733,-1.015733 1.015733,-2.662235 0,-3.677968 L 15.679268,11.999838 19.0412,8.6366048 c 1.015733,-1.015733 1.015733,-2.6622345 0,-3.6779673 z"
+     id="path8934"
+     style="fill:#000000;fill-opacity:0.78;stroke-width:1.30056" />
+</svg>

nw/assets/icons/fallback/forward-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg8980"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata8986">
+    <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>
+  <defs
+     id="defs8984" />
+  <path
+     style="fill:#aeaeae;fill-opacity:1;stroke-width:1.28574"
+     id="path8978"
+     d="m 6.4345258,3.7531206 c 1.002875,-1.0041608 2.63319,-1.0041608 3.6360652,0 l 8.248004,8.2467184 -8.248004,8.246719 C 9.5691528,20.749281 8.9108558,21 8.2525578,21 c -0.658297,0 -1.316595,-0.250719 -1.818032,-0.753442 -1.004161,-1.004161 -1.004161,-2.631904 0,-3.636065 L 11.043894,11.999839 6.4345258,7.3891855 c -1.004161,-1.0041608 -1.004161,-2.6319041 0,-3.6360649 z" />
+</svg>

nw/assets/icons/fallback/forward.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg8980"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata8986">
+    <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>
+  <defs
+     id="defs8984" />
+  <path
+     style="fill:#000000;fill-opacity:0.77999997;stroke-width:1.28574"
+     id="path8978"
+     d="m 6.4345258,3.7531206 c 1.002875,-1.0041608 2.63319,-1.0041608 3.6360652,0 l 8.248004,8.2467184 -8.248004,8.246719 C 9.5691528,20.749281 8.9108558,21 8.2525578,21 c -0.658297,0 -1.316595,-0.250719 -1.818032,-0.753442 -1.004161,-1.004161 -1.004161,-2.631904 0,-3.636065 L 11.043894,11.999839 6.4345258,7.3891855 c -1.004161,-1.0041608 -1.004161,-2.6319041 0,-3.6360649 z" />
+</svg>

nw/assets/icons/fallback/hash-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg5204">
+  <metadata
+     id="metadata5210">
+    <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>
+  <defs
+     id="defs5208" />
+  <path
+     id="rect928"
+     d="M 7.75 2 C 6.7805 2 6 2.7805 6 3.75 L 6 5.5 L 4.1621094 5.5 C 3.2410844 5.5 2.5 6.2805 2.5 7.25 C 2.5 8.2195 3.2410844 9 4.1621094 9 L 6 9 L 6 15 L 4.1621094 15 C 3.2410844 15 2.5 15.7805 2.5 16.75 C 2.5 17.7195 3.2410844 18.5 4.1621094 18.5 L 6 18.5 L 6 20.25 C 6 21.2195 6.7805 22 7.75 22 C 8.7195 22 9.5 21.2195 9.5 20.25 L 9.5 18.5 L 14.5 18.5 L 14.5 20.25 C 14.5 21.2195 15.2805 22 16.25 22 C 17.2195 22 18 21.2195 18 20.25 L 18 18.5 L 19.837891 18.5 C 20.758916 18.5 21.5 17.7195 21.5 16.75 C 21.5 15.7805 20.758916 15 19.837891 15 L 18 15 L 18 9 L 19.837891 9 C 20.758916 9 21.5 8.2195 21.5 7.25 C 21.5 6.2805 20.758916 5.5 19.837891 5.5 L 18 5.5 L 18 3.75 C 18 2.7805 17.2195 2 16.25 2 C 15.2805 2 14.5 2.7805 14.5 3.75 L 14.5 5.5 L 9.5 5.5 L 9.5 3.75 C 9.5 2.7805 8.7195 2 7.75 2 z M 9.5 9 L 14.5 9 L 14.5 15 L 9.5 15 L 9.5 9 z "
+     style="fill:#aeaeae;fill-opacity:1;stroke:none;stroke-width:1.7544229;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+</svg>

nw/assets/icons/fallback/hash.svg

@@ -0,0 +1,31 @@
+<?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"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg5204">
+  <metadata
+     id="metadata5210">
+    <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>
+  <defs
+     id="defs5208" />
+  <path
+     id="rect928"
+     d="M 7.75 2 C 6.7805 2 6 2.7805 6 3.75 L 6 5.5 L 4.1621094 5.5 C 3.2410844 5.5 2.5 6.2805 2.5 7.25 C 2.5 8.2195 3.2410844 9 4.1621094 9 L 6 9 L 6 15 L 4.1621094 15 C 3.2410844 15 2.5 15.7805 2.5 16.75 C 2.5 17.7195 3.2410844 18.5 4.1621094 18.5 L 6 18.5 L 6 20.25 C 6 21.2195 6.7805 22 7.75 22 C 8.7195 22 9.5 21.2195 9.5 20.25 L 9.5 18.5 L 14.5 18.5 L 14.5 20.25 C 14.5 21.2195 15.2805 22 16.25 22 C 17.2195 22 18 21.2195 18 20.25 L 18 18.5 L 19.837891 18.5 C 20.758916 18.5 21.5 17.7195 21.5 16.75 C 21.5 15.7805 20.758916 15 19.837891 15 L 18 15 L 18 9 L 19.837891 9 C 20.758916 9 21.5 8.2195 21.5 7.25 C 21.5 6.2805 20.758916 5.5 19.837891 5.5 L 18 5.5 L 18 3.75 C 18 2.7805 17.2195 2 16.25 2 C 15.2805 2 14.5 2.7805 14.5 3.75 L 14.5 5.5 L 9.5 5.5 L 9.5 3.75 C 9.5 2.7805 8.7195 2 7.75 2 z M 9.5 9 L 14.5 9 L 14.5 15 L 9.5 15 L 9.5 9 z "
+     style="fill:#000000;fill-opacity:0.78039216;stroke:none;stroke-width:1.7544229;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
+</svg>

nw/assets/icons/fallback/maximise-dark.svg

@@ -0,0 +1,56 @@
+<?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:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg7486"
+   sodipodi:docname="arrow-maximise.svg"
+   inkscape:version="1.0 (4035a4fb49, 2020-05-01)">
+  <metadata
+     id="metadata7492">
+    <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>
+  <defs
+     id="defs7490" />
+  <sodipodi:namedview
+     inkscape:document-rotation="0"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="2560"
+     inkscape:window-height="1370"
+     id="namedview7488"
+     showgrid="false"
+     inkscape:zoom="38.125"
+     inkscape:cx="12"
+     inkscape:cy="12"
+     inkscape:window-x="2560"
+     inkscape:window-y="1"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg7486" />
+  <path
+     d="m 15.75,2 c -0.69125,0 -1.25,0.56 -1.25,1.25 0,0.69 0.55875,1.25 1.25,1.25 h 1.9825 l -4.11625,4.11625 c -0.48875,0.48875 -0.48875,1.27875 0,1.7675 C 13.86,10.6275 14.18,10.75 14.5,10.75 c 0.32,0 0.64,-0.1225 0.88375,-0.36625 L 19.5,6.2675 V 8.25 c 0,0.69 0.55875,1.25 1.25,1.25 C 21.44125,9.5 22,8.94 22,8.25 V 2 Z M 8.61625,13.61625 4.5,17.7325 V 15.75 C 4.5,15.06 3.94125,14.5 3.25,14.5 2.55875,14.5 2,15.06 2,15.75 v 6.24875 H 3.245 L 8.25,22 C 8.94,22 9.5,21.44 9.5,20.75 9.5,20.06 8.94125,19.5 8.25,19.5 H 6.2675 l 4.11625,-4.115 c 0.48875,-0.48875 0.48875,-1.27875 0,-1.7675 C 9.895,13.12875 9.105,13.1275 8.61625,13.6163 Z M 5.75,12 C 6.44,12 7,11.44 7,10.75 V 7 h 3.75 C 11.44125,7 12,6.44 12,5.75 12,5.06 11.44125,4.5 10.75,4.5 H 4.50125 L 4.5,10.75 C 4.5,11.44 5.05875,12 5.75,12 Z m 12.5,0 C 17.55875,12 17,12.56 17,13.25 V 17 H 13.25 C 12.55875,17 12,17.56 12,18.25 c 0,0.69 0.55875,1.25 1.25,1.25 H 19.5 V 13.25 C 19.5,12.56 18.94125,12 18.25,12 Z"
+     id="path7484"
+     style="stroke-width:1.25;fill:#aeaeae;fill-opacity:1" />
+</svg>

nw/assets/icons/fallback/maximise.svg

@@ -0,0 +1,56 @@
+<?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:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg7486"
+   sodipodi:docname="arrow-maximise.svg"
+   inkscape:version="1.0 (4035a4fb49, 2020-05-01)">
+  <metadata
+     id="metadata7492">
+    <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>
+  <defs
+     id="defs7490" />
+  <sodipodi:namedview
+     inkscape:document-rotation="0"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="2560"
+     inkscape:window-height="1370"
+     id="namedview7488"
+     showgrid="false"
+     inkscape:zoom="38.125"
+     inkscape:cx="12"
+     inkscape:cy="12"
+     inkscape:window-x="2560"
+     inkscape:window-y="1"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg7486" />
+  <path
+     d="m 15.75,2 c -0.69125,0 -1.25,0.56 -1.25,1.25 0,0.69 0.55875,1.25 1.25,1.25 h 1.9825 l -4.11625,4.11625 c -0.48875,0.48875 -0.48875,1.27875 0,1.7675 C 13.86,10.6275 14.18,10.75 14.5,10.75 c 0.32,0 0.64,-0.1225 0.88375,-0.36625 L 19.5,6.2675 V 8.25 c 0,0.69 0.55875,1.25 1.25,1.25 C 21.44125,9.5 22,8.94 22,8.25 V 2 Z M 8.61625,13.61625 4.5,17.7325 V 15.75 C 4.5,15.06 3.94125,14.5 3.25,14.5 2.55875,14.5 2,15.06 2,15.75 v 6.24875 H 3.245 L 8.25,22 C 8.94,22 9.5,21.44 9.5,20.75 9.5,20.06 8.94125,19.5 8.25,19.5 H 6.2675 l 4.11625,-4.115 c 0.48875,-0.48875 0.48875,-1.27875 0,-1.7675 C 9.895,13.12875 9.105,13.1275 8.61625,13.6163 Z M 5.75,12 C 6.44,12 7,11.44 7,10.75 V 7 h 3.75 C 11.44125,7 12,6.44 12,5.75 12,5.06 11.44125,4.5 10.75,4.5 H 4.50125 L 4.5,10.75 C 4.5,11.44 5.05875,12 5.75,12 Z m 12.5,0 C 17.55875,12 17,12.56 17,13.25 V 17 H 13.25 C 12.55875,17 12,17.56 12,18.25 c 0,0.69 0.55875,1.25 1.25,1.25 H 19.5 V 13.25 C 19.5,12.56 18.94125,12 18.25,12 Z"
+     id="path7484"
+     style="stroke-width:1.25;fill:#000000;fill-opacity:0.77999997" />
+</svg>

nw/assets/icons/fallback/minimise-dark.svg

@@ -0,0 +1,55 @@
+<?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:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
+   sodipodi:docname="arrow-minimise.svg"
+   id="svg8816"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata8822">
+    <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>
+  <defs
+     id="defs8820" />
+  <sodipodi:namedview
+     inkscape:current-layer="svg8816"
+     inkscape:window-maximized="1"
+     inkscape:window-y="1"
+     inkscape:window-x="2560"
+     inkscape:cy="12"
+     inkscape:cx="12"
+     inkscape:zoom="38.125"
+     showgrid="false"
+     id="namedview8818"
+     inkscape:window-height="1370"
+     inkscape:window-width="2560"
+     inkscape:pageshadow="2"
+     inkscape:pageopacity="0"
+     guidetolerance="10"
+     gridtolerance="10"
+     objecttolerance="10"
+     borderopacity="1"
+     bordercolor="#666666"
+     pagecolor="#ffffff" />
+  <path
+     style="fill:#aeaeae;fill-opacity:1;stroke-width:1.24999"
+     id="path8814"
+     d="m 4.6514795,13.249863 c -0.6912284,0 -1.2499609,0.560009 -1.2499609,1.25002 0,0.69001 0.5587325,1.250019 1.2499609,1.250019 h 1.8311928 l -4.1161214,4.116314 c -0.4887347,0.488758 -0.4887347,1.27877 0,1.767528 C 2.6102933,21.877498 2.9302833,22 3.2502733,22 c 0.31999,0 0.63998,-0.122502 0.8837224,-0.366256 l 4.2673662,-4.267567 v 2.133784 c 0,0.69001 0.558733,1.250019 1.249961,1.250019 0.6912291,0 1.0987161,-0.560009 1.0987161,-1.250019 v -6.250098 z m 1.0987157,-2.500039 c 0.6899784,0 1.2499609,-0.560009 1.2499609,-1.2500188 V 6.9997658 h 2.4999218 c 0.6912291,0 1.2499611,-0.5600087 1.2499611,-1.2500195 0,-0.6900108 -0.558732,-1.2500195 -1.2499611,-1.2500195 H 4.5014842 l -0.00125,5.0000784 c 0,0.6900098 0.5587325,1.2500188 1.249961,1.2500188 z m 12.4996098,2.500039 c -0.691229,0 -1.249961,0.560009 -1.249961,1.25002 v 2.500039 h -2.499922 c -0.691229,0 -1.249961,0.560008 -1.249961,1.250019 0,0.690011 0.558732,1.25002 1.249961,1.25002 h 4.999844 v -5.000078 c 0,-0.690011 -0.558733,-1.25002 -1.249961,-1.25002 z M 19.866004,2.3659435 15.749883,6.4822577 V 4.4997268 c 0,-0.6900108 -0.558733,-1.2500195 -1.249961,-1.2500195 -0.691229,0 -1.249961,0.5600087 -1.249961,1.2500195 v 6.2500972 h 6.249805 c 0.689978,0 1.249961,-0.560009 1.249961,-1.2500188 0,-0.690011 -0.558733,-1.25002 -1.249961,-1.25002 h -1.982438 l 4.116121,-4.1150641 c 0.488735,-0.4887576 0.488735,-1.2787699 0,-1.7675276 -0.488735,-0.4887576 -1.27871,-0.4900076 -1.767445,-0.00125 z" />
+</svg>

nw/assets/icons/fallback/minimise.svg

@@ -0,0 +1,55 @@
+<?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:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
+   sodipodi:docname="arrow-minimise.svg"
+   id="svg8816"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata8822">
+    <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>
+  <defs
+     id="defs8820" />
+  <sodipodi:namedview
+     inkscape:current-layer="svg8816"
+     inkscape:window-maximized="1"
+     inkscape:window-y="1"
+     inkscape:window-x="2560"
+     inkscape:cy="12"
+     inkscape:cx="12"
+     inkscape:zoom="38.125"
+     showgrid="false"
+     id="namedview8818"
+     inkscape:window-height="1370"
+     inkscape:window-width="2560"
+     inkscape:pageshadow="2"
+     inkscape:pageopacity="0"
+     guidetolerance="10"
+     gridtolerance="10"
+     objecttolerance="10"
+     borderopacity="1"
+     bordercolor="#666666"
+     pagecolor="#ffffff" />
+  <path
+     style="fill:#000000;fill-opacity:0.77999997;stroke-width:1.24999"
+     id="path8814"
+     d="m 4.6514795,13.249863 c -0.6912284,0 -1.2499609,0.560009 -1.2499609,1.25002 0,0.69001 0.5587325,1.250019 1.2499609,1.250019 h 1.8311928 l -4.1161214,4.116314 c -0.4887347,0.488758 -0.4887347,1.27877 0,1.767528 C 2.6102933,21.877498 2.9302833,22 3.2502733,22 c 0.31999,0 0.63998,-0.122502 0.8837224,-0.366256 l 4.2673662,-4.267567 v 2.133784 c 0,0.69001 0.558733,1.250019 1.249961,1.250019 0.6912291,0 1.0987161,-0.560009 1.0987161,-1.250019 v -6.250098 z m 1.0987157,-2.500039 c 0.6899784,0 1.2499609,-0.560009 1.2499609,-1.2500188 V 6.9997658 h 2.4999218 c 0.6912291,0 1.2499611,-0.5600087 1.2499611,-1.2500195 0,-0.6900108 -0.558732,-1.2500195 -1.2499611,-1.2500195 H 4.5014842 l -0.00125,5.0000784 c 0,0.6900098 0.5587325,1.2500188 1.249961,1.2500188 z m 12.4996098,2.500039 c -0.691229,0 -1.249961,0.560009 -1.249961,1.25002 v 2.500039 h -2.499922 c -0.691229,0 -1.249961,0.560008 -1.249961,1.250019 0,0.690011 0.558732,1.25002 1.249961,1.25002 h 4.999844 v -5.000078 c 0,-0.690011 -0.558733,-1.25002 -1.249961,-1.25002 z M 19.866004,2.3659435 15.749883,6.4822577 V 4.4997268 c 0,-0.6900108 -0.558733,-1.2500195 -1.249961,-1.2500195 -0.691229,0 -1.249961,0.5600087 -1.249961,1.2500195 v 6.2500972 h 6.249805 c 0.689978,0 1.249961,-0.560009 1.249961,-1.2500188 0,-0.690011 -0.558733,-1.25002 -1.249961,-1.25002 h -1.982438 l 4.116121,-4.1150641 c 0.488735,-0.4887576 0.488735,-1.2787699 0,-1.7675276 -0.488735,-0.4887576 -1.27871,-0.4900076 -1.767445,-0.00125 z" />
+</svg>

nw/assets/icons/fallback/proj_nwx.svg

@@ -0,0 +1,207 @@
+<?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>

nw/assets/icons/fallback/reference-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg1321"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata1327">
+    <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>
+  <defs
+     id="defs1325" />
+  <path
+     style="stroke-width:1.25;fill:#aeaeae;fill-opacity:1"
+     id="path1319"
+     d="M 12,2 C 6.48625,2 2,6.48625 2,12 c 0,5.51375 4.48625,10 10,10 2.02,0 3.965,-0.59875 5.62375,-1.73 0.57,-0.39 0.7175,-1.1675 0.32875,-1.7375 -0.38875,-0.57125 -1.165,-0.715 -1.7375,-0.32875 C 14.9725,19.0525 13.515,19.5 12,19.5 7.86375,19.5 4.5,16.13625 4.5,12 4.5,7.86375 7.86375,4.5 12,4.5 c 4.13625,0 7.5,3.36375 7.5,7.5 v 0.625 c 0,0.69 -0.56,1.25 -1.25,1.25 -0.69,0 -1.25,-0.56 -1.25,-1.25 v -3.75 c 0,-0.69125 -0.55875,-1.25 -1.25,-1.25 -0.55125,0 -1.00625,0.3625 -1.1725,0.86 C 13.8525,7.95125 12.96625,7.625 12,7.625 9.5875,7.625 7.625,9.5875 7.625,12 c 0,2.4125 1.9625,4.375 4.375,4.375 1.30625,0 2.46875,-0.5875 3.27,-1.49875 0.685,0.90375 1.76,1.49875 2.98,1.49875 2.0675,0 3.75,-1.6825 3.75,-3.75 V 12 C 22,6.48625 17.51375,2 12,2 Z m 0,11.875 c -1.03375,0 -1.875,-0.84125 -1.875,-1.875 0,-1.03375 0.84125,-1.875 1.875,-1.875 1.03375,0 1.875,0.84125 1.875,1.875 0,1.03375 -0.84125,1.875 -1.875,1.875 z" />
+</svg>

nw/assets/icons/fallback/reference.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg1321"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata1327">
+    <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>
+  <defs
+     id="defs1325" />
+  <path
+     style="stroke-width:1.25;fill:#000000;fill-opacity:0.78039217"
+     id="path1319"
+     d="M 12,2 C 6.48625,2 2,6.48625 2,12 c 0,5.51375 4.48625,10 10,10 2.02,0 3.965,-0.59875 5.62375,-1.73 0.57,-0.39 0.7175,-1.1675 0.32875,-1.7375 -0.38875,-0.57125 -1.165,-0.715 -1.7375,-0.32875 C 14.9725,19.0525 13.515,19.5 12,19.5 7.86375,19.5 4.5,16.13625 4.5,12 4.5,7.86375 7.86375,4.5 12,4.5 c 4.13625,0 7.5,3.36375 7.5,7.5 v 0.625 c 0,0.69 -0.56,1.25 -1.25,1.25 -0.69,0 -1.25,-0.56 -1.25,-1.25 v -3.75 c 0,-0.69125 -0.55875,-1.25 -1.25,-1.25 -0.55125,0 -1.00625,0.3625 -1.1725,0.86 C 13.8525,7.95125 12.96625,7.625 12,7.625 9.5875,7.625 7.625,9.5875 7.625,12 c 0,2.4125 1.9625,4.375 4.375,4.375 1.30625,0 2.46875,-0.5875 3.27,-1.49875 0.685,0.90375 1.76,1.49875 2.98,1.49875 2.0675,0 3.75,-1.6825 3.75,-3.75 V 12 C 22,6.48625 17.51375,2 12,2 Z m 0,11.875 c -1.03375,0 -1.875,-0.84125 -1.875,-1.875 0,-1.03375 0.84125,-1.875 1.875,-1.875 1.03375,0 1.875,0.84125 1.875,1.875 0,1.03375 -0.84125,1.875 -1.875,1.875 z" />
+</svg>

nw/assets/icons/fallback/refresh-dark.svg

@@ -0,0 +1,56 @@
+<?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:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg6649"
+   sodipodi:docname="refresh.svg"
+   inkscape:version="1.0 (4035a4fb49, 2020-05-01)">
+  <metadata
+     id="metadata6655">
+    <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>
+  <defs
+     id="defs6653" />
+  <sodipodi:namedview
+     inkscape:document-rotation="0"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="2560"
+     inkscape:window-height="1370"
+     id="namedview6651"
+     showgrid="false"
+     inkscape:zoom="38.125"
+     inkscape:cx="12"
+     inkscape:cy="12"
+     inkscape:window-x="2560"
+     inkscape:window-y="1"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg6649" />
+  <path
+     d="M 13.162667,12.25611 H 20 V 5.4213831 C 19.989333,3.9083317 19.105333,3.5443996 18.036,4.6148668 L 16.497333,6.1585791 C 15.144,5.0987766 13.488,4.5188846 11.742667,4.5188846 9.676,4.5188846 7.7306667,5.3240679 6.2706667,6.7864621 4.8053333,8.242191 4,10.189828 4,12.25611 4,14.326391 4.8053333,16.271361 6.268,17.731089 7.7306667,19.193484 9.674667,20 11.742667,20 c 2.066666,0 4.012,-0.806516 5.474666,-2.270244 0.394667,-0.395926 0.744,-0.827845 1.04,-1.286427 C 18.72,15.72213 18.510667,14.763642 17.790667,14.303728 17.072,13.842481 16.113333,14.051775 15.652,14.770308 c -0.177333,0.275948 -0.389333,0.533234 -0.624,0.773189 -0.878667,0.87717 -2.045333,1.359747 -3.285333,1.359747 -1.24,0 -2.406667,-0.481244 -3.285334,-1.359747 -0.8759997,-0.87717 -1.3599997,-2.043619 -1.3599997,-3.286054 0,-1.239769 0.4826667,-2.406219 1.3599997,-3.280722 0.878667,-0.87717 2.045334,-1.36108 3.285334,-1.36108 0.917333,0 1.794666,0.26795 2.545333,0.762525 l -1.930667,1.934306 c -1.070666,1.069134 -0.706666,1.943638 0.805334,1.943638 z"
+     id="path6647"
+     style="fill:#aeaeae;fill-opacity:1;stroke-width:1.33321" />
+</svg>

nw/assets/icons/fallback/refresh.svg

@@ -0,0 +1,56 @@
+<?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:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg6649"
+   sodipodi:docname="refresh.svg"
+   inkscape:version="1.0 (4035a4fb49, 2020-05-01)">
+  <metadata
+     id="metadata6655">
+    <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>
+  <defs
+     id="defs6653" />
+  <sodipodi:namedview
+     inkscape:document-rotation="0"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="2560"
+     inkscape:window-height="1370"
+     id="namedview6651"
+     showgrid="false"
+     inkscape:zoom="38.125"
+     inkscape:cx="12"
+     inkscape:cy="12"
+     inkscape:window-x="2560"
+     inkscape:window-y="1"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg6649" />
+  <path
+     d="M 13.162667,12.25611 H 20 V 5.4213831 C 19.989333,3.9083317 19.105333,3.5443996 18.036,4.6148668 L 16.497333,6.1585791 C 15.144,5.0987766 13.488,4.5188846 11.742667,4.5188846 9.676,4.5188846 7.7306667,5.3240679 6.2706667,6.7864621 4.8053333,8.242191 4,10.189828 4,12.25611 4,14.326391 4.8053333,16.271361 6.268,17.731089 7.7306667,19.193484 9.674667,20 11.742667,20 c 2.066666,0 4.012,-0.806516 5.474666,-2.270244 0.394667,-0.395926 0.744,-0.827845 1.04,-1.286427 C 18.72,15.72213 18.510667,14.763642 17.790667,14.303728 17.072,13.842481 16.113333,14.051775 15.652,14.770308 c -0.177333,0.275948 -0.389333,0.533234 -0.624,0.773189 -0.878667,0.87717 -2.045333,1.359747 -3.285333,1.359747 -1.24,0 -2.406667,-0.481244 -3.285334,-1.359747 -0.8759997,-0.87717 -1.3599997,-2.043619 -1.3599997,-3.286054 0,-1.239769 0.4826667,-2.406219 1.3599997,-3.280722 0.878667,-0.87717 2.045334,-1.36108 3.285334,-1.36108 0.917333,0 1.794666,0.26795 2.545333,0.762525 l -1.930667,1.934306 c -1.070666,1.069134 -0.706666,1.943638 0.805334,1.943638 z"
+     id="path6647"
+     style="fill:#000000;fill-opacity:0.77999997;stroke-width:1.33321" />
+</svg>

nw/assets/icons/fallback/remove-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   id="svg5204"
+   viewBox="0 0 24 24"
+   height="24"
+   width="24"
+   version="1.2">
+  <metadata
+     id="metadata5210">
+    <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>
+  <defs
+     id="defs5208" />
+  <path
+     style="stroke-width:1.25;fill:#aeaeae;fill-opacity:1"
+     id="path5202"
+     d="M 19.5,9.5 H 4.5 C 3.12,9.5 2,10.62 2,12 c 0,1.38 1.12,2.5 2.5,2.5 h 15 C 20.88,14.5 22,13.38 22,12 22,10.62 20.88,9.5 19.5,9.5 Z" />
+</svg>

nw/assets/icons/fallback/remove.svg

@@ -0,0 +1,31 @@
+<?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"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg5204">
+  <metadata
+     id="metadata5210">
+    <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>
+  <defs
+     id="defs5208" />
+  <path
+     d="M 19.5,9.5 H 4.5 C 3.12,9.5 2,10.62 2,12 c 0,1.38 1.12,2.5 2.5,2.5 h 15 C 20.88,14.5 22,13.38 22,12 22,10.62 20.88,9.5 19.5,9.5 Z"
+     id="path5202"
+     style="stroke-width:1.25;fill:#000000;fill-opacity:0.77999997" />
+</svg>

nw/assets/icons/fallback/search-dark.svg

@@ -0,0 +1,31 @@
+<?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"
+   version="1.2"
+   width="24"
+   height="24"
+   viewBox="0 0 24 24"
+   id="svg873">
+  <metadata
+     id="metadata879">
+    <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>
+  <defs
+     id="defs877" />
+  <path
+     d="M 19.769714,14.460577 19.131808,13.821482 18.240407,12.92889 C 18.510564,12.110086 18.66171,11.238917 18.66171,10.330854 18.66171,5.7381732 14.923537,2 10.330856,2 5.7381752,2 2.000002,5.7381732 2.000002,10.330854 c 0,4.592681 3.7381732,8.330854 8.330854,8.330854 0.908063,0 1.780422,-0.151146 2.599226,-0.421303 l 0.892591,0.891401 1.799465,1.797084 0.07259,0.0726 0.07617,0.06545 C 16.486163,21.669146 17.375184,22 18.274916,22 c 2.054151,0 3.725082,-1.670931 3.725082,-3.726271 0,-0.999704 -0.390359,-1.937519 -1.099672,-2.639692 z M 4.3790558,10.330854 c 0,-3.2811664 2.6694437,-5.9506101 5.9506102,-5.9506101 3.281166,0 5.95061,2.6694437 5.95061,5.9506101 0,3.281166 -2.669444,5.95061 -5.95061,5.95061 -3.2811665,0 -5.9506102,-2.669444 -5.9506102,-5.95061 z"
+     id="path871"
+     style="fill:#aeaeae;fill-opacity:1;stroke-width:1.19012" />
+</svg>