70d74e675f
- Rename project name and package: novelWriter -> UmbraEdit, novelwriter -> umbraedit - Rename entry script novelWriter.py -> UmbraEdit.py - Rename package directory novelwriter/ -> umbraedit/ - Rename i18n translation sources nw_*.ts -> ue_*.ts - Rename packaging files (appdata, project xml template) - Update all imports, references, docs, workflows, tests and build config - Update pyproject.toml project name, GUI script and URLs - Preserve full upstream git history; origin repointed below
66 lines
2.2 KiB
ReStructuredText
66 lines
2.2 KiB
ReStructuredText
.. _docs_technical_locations:
|
|
|
|
**************
|
|
File Locations
|
|
**************
|
|
|
|
.. _QStandardPaths: https://doc.qt.io/qt-6/qstandardpaths.html
|
|
|
|
UmbraEdit will create a few files on your system outside of the application folder itself. These
|
|
file locations are described in this chapter.
|
|
|
|
|
|
.. _docs_technical_locations_conf:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
The general configuration of UmbraEdit, including everything that is in **Preferences**, is saved
|
|
in one central configuration file. The location of this file depends on your operating system. The
|
|
system paths are provided by the Qt QStandardPaths_ class and its ``ConfigLocation`` value.
|
|
|
|
The standard paths are:
|
|
|
|
* Linux: ``~/.config/umbraedit/umbraedit.conf``
|
|
* MacOS: ``~/Library/Preferences/umbraedit/umbraedit.conf``
|
|
* Windows: ``C:\Users\<USER>\AppData\Local\umbraedit\umbraedit.conf``
|
|
|
|
Here, ``~`` corresponds to the user's home directory on Linux and MacOS, and ``<USER>`` is the
|
|
user's username on Windows.
|
|
|
|
.. note::
|
|
These are the standard operating system defined locations. If your system has been set up in a
|
|
different way, these locations may also be different.
|
|
|
|
|
|
.. _docs_technical_locations_data:
|
|
|
|
Application Data
|
|
================
|
|
|
|
UmbraEdit also stores a bit of data that is generated by the user's actions. This includes the
|
|
list of recent projects form the **Welcome** dialog. Custom themes should also be saved here. The
|
|
system paths are provided by the Qt QStandardPaths_ class and its ``AppDataLocation`` value.
|
|
|
|
The standard paths are:
|
|
|
|
* Linux: ``~/.local/share/umbraedit/``
|
|
* MacOS: ``~/Library/Application Support/umbraedit/``
|
|
* Windows: ``C:\Users\<USER>\AppData\Roaming\umbraedit\``
|
|
|
|
Here, ``~`` corresponds to the user's home directory on Linux and MacOS, and ``<USER>`` is the
|
|
user's username on Windows.
|
|
|
|
.. note::
|
|
These are the standard operating system defined locations. If your system has been set up in a
|
|
different way, these locations may also be different.
|
|
|
|
The Application Data location also holds several folders:
|
|
|
|
``cache``
|
|
This folder is used to save the preview data for the **Manuscript Build** tool.
|
|
|
|
``icons``, ``syntax`` and ``themes``
|
|
These folders are empty by default, but this is where the user can store custom theme files.
|
|
See :ref:`docs_more_custom` for more details.
|