Merge branch 'main' into i18n
This commit is contained in:
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
@@ -27,11 +27,11 @@ JSON files. See the :ref:`a_breakdown_storage` section for more details.
|
|||||||
|
|
||||||
Any operating system that can run Python 3 and has the Qt 5 libraries should be able to run
|
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
|
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 packages or the pip
|
as well. novelWriter can also be run directly from the Python source, or installed from packages or
|
||||||
tool. See :ref:`a_started` for more details.
|
the pip tool. See :ref:`a_started` for more details.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
Version 1.5 introduced a few changes that will require you to make a few minor modifications to
|
Version 1.5 introduced a few changes that will require you to make some minor modifications to
|
||||||
some of the headings in your project. It should be fairly quick and straightforward. Please see
|
some of the headings in your project. It should be fairly quick and straightforward. Please see
|
||||||
the :ref:`a_prjfmt_1_3` section for more details.
|
the :ref:`a_prjfmt_1_3` section for more details.
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,9 @@
|
|||||||
Customisations
|
Customisations
|
||||||
**************
|
**************
|
||||||
|
|
||||||
|
.. _Enchant: https://abiword.github.io/enchant
|
||||||
|
.. _Free Desktop: https://cgit.freedesktop.org/libreoffice/dictionaries/tree/
|
||||||
|
|
||||||
There are a few ways you can customise novelWriter youself. Currently, you can add new GUI themes,
|
There are a few ways you can customise novelWriter youself. Currently, you can add new GUI themes,
|
||||||
your own syntax themes, and install additional dictionaries.
|
your own syntax themes, and install additional dictionaries.
|
||||||
|
|
||||||
@@ -13,19 +16,20 @@ your own syntax themes, and install additional dictionaries.
|
|||||||
Spell Check Dictionaries
|
Spell Check Dictionaries
|
||||||
========================
|
========================
|
||||||
|
|
||||||
novelWriter uses `Enchant <https://abiword.github.io/enchant/>`_ as the spell checking tool.
|
novelWriter uses Enchant_ as the spell checking tool. Depending on you operating system, it may or
|
||||||
Depending on you operating system, it may or may not load installed spell check dictionaries.
|
may not load installed spell check dictionaries.
|
||||||
|
|
||||||
Linux
|
Linux
|
||||||
On Linux, you generally only have to install hunspell or aspell dictionaries on your system like
|
On Linux, you generally only have to install hunspell or aspell dictionaries on your system like
|
||||||
you do for other applications. See your distro's documentation for how to do this.
|
you do for other applications. See your distro's documentation for how to do this. These
|
||||||
|
dictionaries should then show up as available spell check languages in novelWriter.
|
||||||
|
|
||||||
Windows
|
Windows
|
||||||
For Windows, English is included with the installation. For other languages you have to download
|
For Windows, English is included with the installation. For other languages you have to download
|
||||||
and add dictionaries yourself. You can find the various dictionaries on the
|
and add dictionaries yourself. You can find the various dictionaries on the `Free Desktop`_
|
||||||
`Free Desktop <https://cgit.freedesktop.org/libreoffice/dictionaries/tree/>`_ website. You should
|
website. You should find a folder for your language, if it is available at all, and download the
|
||||||
find a folder for your language, if it is available at all, and download the files ending with
|
files ending with ``.aff`` and ``.dic``. These files must then be copied to the following
|
||||||
``.aff`` and ``.dic``. These files must then be copied to the following location:
|
location:
|
||||||
|
|
||||||
``C:\Users\<USER>\AppData\Local\enchant\hunspell``
|
``C:\Users\<USER>\AppData\Local\enchant\hunspell``
|
||||||
|
|
||||||
@@ -50,11 +54,12 @@ modify it as you like.
|
|||||||
`novelwriter/assets/themes <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/themes>`_.
|
`novelwriter/assets/themes <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/themes>`_.
|
||||||
|
|
||||||
Remember to also change the name of your theme by modifying the ``name`` setting at the top of the
|
Remember to also change the name of your theme by modifying the ``name`` setting at the top of the
|
||||||
file.
|
file, otherwise you may not be able to distinguish them in :guilabel:`Preferences`.
|
||||||
|
|
||||||
For novelWriter to be able to locate the custom theme files, you must copy them to the
|
For novelWriter to be able to locate the custom theme files, you must copy them to the
|
||||||
:ref:`a_locations_data` location in your home or user area. There should be a folder there named
|
:ref:`a_locations_data` location in your home or user area. There should be a folder there named
|
||||||
``syntax`` for syntax themes and just ``themes`` for GUI themes.
|
``syntax`` for syntax themes and just ``themes`` for GUI themes. These folders are created the
|
||||||
|
first time you start novelWriter.
|
||||||
|
|
||||||
Once the files are copied there, they should show up in :guilabel:`Preferences` with the label you
|
Once the files are copied there, they should show up in :guilabel:`Preferences` with the label you
|
||||||
set as ``name`` inside the file.
|
set as ``name`` inside the file.
|
||||||
|
|||||||
@@ -4,10 +4,19 @@
|
|||||||
Key Features
|
Key Features
|
||||||
************
|
************
|
||||||
|
|
||||||
novelWriter is a multi-document plain text editor using a markup syntax inspired by Markdown to
|
.. _Snowflake : https://www.advancedfictionwriting.com/articles/snowflake-method/
|
||||||
apply simple formatting to the text. It is designed for writing novels, so the formatting features
|
|
||||||
are limited to those relevant for this purpose. Your novel project is organised as a collection of
|
At the core, novelWriter is a multi-document plain text editor. It uses a markup syntax inspired by
|
||||||
separate plain text documents instead of a single, large document.
|
Markdown to apply simple formatting to the text. It is designed for writing fiction, so the
|
||||||
|
formatting features are limited to those relevant for this purpose. It is not suitable for
|
||||||
|
technical writing.
|
||||||
|
|
||||||
|
Your novel project is organised as a collection of separate plain text documents instead of a
|
||||||
|
single, large document. The idea here is to make it easier to reorganise your project structure
|
||||||
|
without having to cut and paste text.
|
||||||
|
|
||||||
|
You can at any point split documents by their header, or merge multiple documents into single
|
||||||
|
documents. This makes it easier to use variations of the popular Snowflake_ method for writing.
|
||||||
|
|
||||||
Below are some key features of novelWriter.
|
Below are some key features of novelWriter.
|
||||||
|
|
||||||
@@ -33,24 +42,25 @@ Below are some key features of novelWriter.
|
|||||||
|
|
||||||
**Keep track of your plot elements**
|
**Keep track of your plot elements**
|
||||||
All notes in your project can be assigned a *tag* you can *reference* from any other document or
|
All notes in your project can be assigned a *tag* you can *reference* from any other document or
|
||||||
notes. In fact, you can add a new tag under each heading of a note if you need to be able to
|
note. In fact, you can add a new tag under each heading of a note if you need to be able to
|
||||||
reference a specific section. Note tags are organised into categories with specific reference
|
reference a specific section. Note tags are organised into categories with specific reference
|
||||||
keywords.
|
keywords.
|
||||||
|
|
||||||
**Get an overview of your plot elements**
|
**Get an overview of your plot elements**
|
||||||
In the :guilabel:`Outline View` on the main window you can see an outline of all the chapters,
|
In the :guilabel:`Outline View` on the main window you can see an outline of all the chapters,
|
||||||
scenes, and sections of your project. If they have any references in them, these are listed in
|
scenes, and sections of your project. If they have any references in them, these are listed in
|
||||||
columns. You can also add a synopsis to each document, which can be listed here. You have the
|
additional columns. You can also add a synopsis to each document, which can be listed here as
|
||||||
option to add or remove columns of information from the outline. A subset of the outline
|
well. You have the option to add or remove columns of information from this outline. A subset of
|
||||||
information is also available in the :guilabel:`Novel View` as a replacement for the main
|
the outline information is also available in the :guilabel:`Novel View` as a replacement for the
|
||||||
project tree.
|
main project tree.
|
||||||
|
|
||||||
**Building your manuscript**
|
**Building your manuscript**
|
||||||
Whether you want to compile a manuscript, or export all your notes, or generate an outline of
|
Whether you want to compile a manuscript, or export all your notes, or generate an outline of
|
||||||
your chapters and scenes with a synopsis, you can use the :guilabel:`Build Novel Project` tool.
|
your chapters and scenes with a synopsis, you can use the :guilabel:`Build Novel Project` tool.
|
||||||
The tool lets you select what information you want to include in the generated document, and how
|
The tool lets you select what information you want to include in the generated document, and how
|
||||||
it is formatted. You can send the result to a printer, a PDF, or to an Open Document file that
|
it is formatted. You can send the result to a printer, a PDF, or to an Open Document file that
|
||||||
can be opened by most office type word processors.
|
can be opened by most office type word processors. You can also generate the result as HTML, or
|
||||||
|
Markdown, both suitable for further conversion to other formats.
|
||||||
|
|
||||||
|
|
||||||
.. _a_intro_screenshots:
|
.. _a_intro_screenshots:
|
||||||
@@ -58,7 +68,7 @@ Below are some key features of novelWriter.
|
|||||||
Screenshots
|
Screenshots
|
||||||
===========
|
===========
|
||||||
|
|
||||||
**novelWriter with default system theme:**
|
**novelWriter with default theme:**
|
||||||
|
|
||||||
.. image:: images/screenshot_default.png
|
.. image:: images/screenshot_default.png
|
||||||
:width: 800
|
:width: 800
|
||||||
|
|||||||
@@ -15,11 +15,13 @@ language that doesn't require a compiler to build and run. That means that the c
|
|||||||
computer right out of the box, or from a zip file.
|
computer right out of the box, or from a zip file.
|
||||||
|
|
||||||
While it is developed for Linux primarily, it runs just fine on Windows as well. It also works fine
|
While it is developed for Linux primarily, it runs just fine on Windows as well. It also works fine
|
||||||
on macOS, but the author is not a mac user, so less attention is paid to that platform.
|
on macOS, but the author is not a mac user, so support for mac is dependant on user feedback and
|
||||||
|
contributions.
|
||||||
|
|
||||||
In order to run novelWriter, you also need a few additional packages. The user interface is built
|
In order to run novelWriter, you also need a few additional packages. The user interface is built
|
||||||
with `Qt 5 <https://www.qt.io/>`_, a cross platform library for building graphical user interface
|
with `Qt 5 <https://www.qt.io/>`_, a cross platform library for building graphical user interface
|
||||||
applications.
|
applications. It also uses a third party XML package. If you want spell checking, you also need the
|
||||||
|
spell check package Enchant developed for AbiWord
|
||||||
|
|
||||||
For install instructions, see :ref:`a_started`.
|
For install instructions, see :ref:`a_started`.
|
||||||
|
|
||||||
@@ -43,12 +45,12 @@ read on.
|
|||||||
:ref:`a_fmt` – Essential Information
|
:ref:`a_fmt` – Essential Information
|
||||||
This section covers how you should format your text. The editor is plain text, so text
|
This section covers how you should format your text. The editor is plain text, so text
|
||||||
formatting requires some basic markup. The structure of your novel is also inferred by how you
|
formatting requires some basic markup. The structure of your novel is also inferred by how you
|
||||||
use the title headings. Tags and references are implemented by simple codes.
|
use headings. Tags and references are implemented by simple codes.
|
||||||
|
|
||||||
:ref:`a_kb` – Optional / Lookup
|
:ref:`a_kb` – Optional / Lookup
|
||||||
This section lists all the keyboard shortcuts in novelWriter and what they do. Most of the
|
This section lists all the keyboard shortcuts in novelWriter and what they do. Most of the
|
||||||
shortcuts are also listed next to the menu items inside the app, so this section is mostly for
|
shortcuts are also listed next to the menu items inside the app, or in tool tips, so this
|
||||||
reference.
|
section is mostly for reference.
|
||||||
|
|
||||||
:ref:`a_typ` – Optional
|
:ref:`a_typ` – Optional
|
||||||
This section gives you an overview of the special typographical symbols available in
|
This section gives you an overview of the special typographical symbols available in
|
||||||
@@ -72,8 +74,8 @@ to take advantage of these features, you must structure your text in a specific
|
|||||||
meta data for it to extract.
|
meta data for it to extract.
|
||||||
|
|
||||||
:ref:`a_proj` – Essential Information
|
:ref:`a_proj` – Essential Information
|
||||||
This section explains how you organise the content of your project, how to customise the text,
|
This section explains how you organise the content of your project, and how to set up automated
|
||||||
and how to set up automated backups of your work.
|
backups of your work.
|
||||||
|
|
||||||
:ref:`a_struct` – Essential Information
|
:ref:`a_struct` – Essential Information
|
||||||
This section covers the way your novel's structure is encoded into the text documents. It
|
This section covers the way your novel's structure is encoded into the text documents. It
|
||||||
|
|||||||
@@ -15,8 +15,7 @@ to build the various components like the translation files and documentation.
|
|||||||
.. note::
|
.. note::
|
||||||
The text below assumes the command ``python`` corresponds to a Python 3 executable. Python 2 is
|
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
|
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
|
``python3`` may be needed instead. Likewise, ``pip`` may need to be replaced with ``pip3``.
|
||||||
without the ``python`` command. Likewise, ``pip`` may need to be replaced with ``pip3``.
|
|
||||||
|
|
||||||
|
|
||||||
.. _a_source_depend:
|
.. _a_source_depend:
|
||||||
@@ -34,10 +33,10 @@ The following Python packages are needed to run novelWriter:
|
|||||||
* ``lxml`` – needed for full XML support.
|
* ``lxml`` – needed for full XML support.
|
||||||
* ``PyEnchant`` – needed for spell checking (optional).
|
* ``PyEnchant`` – needed for spell checking (optional).
|
||||||
|
|
||||||
PyQt/Qt should be at least 5.10, but ideally 5.13 or higher for nearly all features to work. For
|
PyQt/Qt should be at least 5.10, but ideally 5.13 or higher for all features to work. For instance,
|
||||||
instance, searching using regular expressions with full Unicode support requires 5.13. There is no
|
searching using regular expressions with full Unicode support requires 5.13. There is no known
|
||||||
known minimum version requirement for package ``lxml``, but the code was originally written with
|
minimum version requirement for package ``lxml``, but the code was originally written with 4.2,
|
||||||
4.2, which is therefore set as the minimum. It may work on lower versions. You have to test it.
|
which is therefore set as the minimum. It may work on lower versions. You have to test it.
|
||||||
|
|
||||||
If you want spell checking, you must install the ``PyEnchant`` package. The spell check library
|
If you want spell checking, you must install the ``PyEnchant`` package. The spell check library
|
||||||
must be at least 3.0 to work with Windows. On Linux, 2.0 also works fine.
|
must be at least 3.0 to work with Windows. On Linux, 2.0 also works fine.
|
||||||
@@ -102,12 +101,12 @@ You can build the ``.qm`` files with:
|
|||||||
python setup.py qtlrelease
|
python setup.py qtlrelease
|
||||||
|
|
||||||
This requires that the Qt Linguist tool is installed on your system. On Ubuntu and Debian, the
|
This requires that the Qt Linguist tool is installed on your system. On Ubuntu and Debian, the
|
||||||
needed package is called `qttools5-dev-tools`.
|
needed package is called ``qttools5-dev-tools``.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
If you want to improve novelWriter with translation files for another language, or update an
|
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.md file in
|
existing translation, instructions for how to contribute can be found in the ``README.md`` file
|
||||||
the ``i18n`` folder of the source code.
|
in the ``i18n`` folder of the source code.
|
||||||
|
|
||||||
|
|
||||||
.. _a_source_sample:
|
.. _a_source_sample:
|
||||||
|
|||||||
+11
-11
@@ -53,7 +53,7 @@ Install on Linux
|
|||||||
================
|
================
|
||||||
|
|
||||||
A Debian package can be downloaded from the `main website`_, or from the Releases_ page on GitHub.
|
A Debian package can be downloaded from the `main website`_, or from the Releases_ page on GitHub.
|
||||||
This package should work on both Debian, Ubuntu and Linux Mint.
|
This package should work on both Debian, Ubuntu and Linux Mint, at least.
|
||||||
|
|
||||||
If you prefer, you can also add the novelWriter repository on Launchpad to your package manager.
|
If you prefer, you can also add the novelWriter repository on Launchpad to your package manager.
|
||||||
|
|
||||||
@@ -98,12 +98,12 @@ Then run the update and install commands as for Ubuntu:
|
|||||||
different compression algorithm that Debian doesn't currently support.
|
different compression algorithm that Debian doesn't currently support.
|
||||||
|
|
||||||
|
|
||||||
Other Distros
|
AppImage Releases
|
||||||
-------------
|
-----------------
|
||||||
|
|
||||||
For other Linux distros than the ones mentioned above, the primary option is AppImage_. These are
|
For other Linux distros than the ones mentioned above, the primary option is AppImage_. These are
|
||||||
completely standalone images for the app that include the necessary environment to run novelWriter.
|
completely standalone images for the app that include the necessary environment to run novelWriter.
|
||||||
They can be run on any Linux distro.
|
They can of course be run on any Linux distro, if you prefer this to native packages.
|
||||||
|
|
||||||
|
|
||||||
.. _a_started_minimal:
|
.. _a_started_minimal:
|
||||||
@@ -120,8 +120,8 @@ These zip files don't include any dependencies, so you must install them separat
|
|||||||
|
|
||||||
.. _a_started_minimal_windows:
|
.. _a_started_minimal_windows:
|
||||||
|
|
||||||
Windows
|
Minimal Package on Windows
|
||||||
-------
|
--------------------------
|
||||||
|
|
||||||
First, make sure you have Python installed on your system. If you don't, you can download it from
|
First, make sure you have Python installed on your system. If you don't, you can download it from
|
||||||
`python.org`_. Python 3.7 or higher is required, but it is recommended that you install the latest
|
`python.org`_. Python 3.7 or higher is required, but it is recommended that you install the latest
|
||||||
@@ -149,8 +149,8 @@ you can just delete the novelWriter folder.
|
|||||||
|
|
||||||
.. _a_started_minimal_linux:
|
.. _a_started_minimal_linux:
|
||||||
|
|
||||||
Linux
|
Minimal Package on Linux
|
||||||
-----
|
------------------------
|
||||||
|
|
||||||
On Linux you need to install the following packages on Debian-based distros, including Ubuntu and
|
On Linux you need to install the following packages on Debian-based distros, including Ubuntu and
|
||||||
Linux Mint:
|
Linux Mint:
|
||||||
@@ -167,7 +167,7 @@ On Fedora, you need the following packages:
|
|||||||
|
|
||||||
A standard desktop launcher can be installed via the main setup script. It will create the needed
|
A standard desktop launcher can be installed via the main setup script. It will create the needed
|
||||||
desktop file and add it to the Applications menu. The necessary icons will also be installed, and a
|
desktop file and add it to the Applications menu. The necessary icons will also be installed, and a
|
||||||
file association with ``.nwx`` files added.
|
file association with ``.nwx`` project files added.
|
||||||
|
|
||||||
To set this up, run the following from inside the extracted novelWriter folder:
|
To set this up, run the following from inside the extracted novelWriter folder:
|
||||||
|
|
||||||
@@ -186,8 +186,8 @@ To uninstall the icons, run:
|
|||||||
|
|
||||||
.. _a_started_minimal_mac:
|
.. _a_started_minimal_mac:
|
||||||
|
|
||||||
macOS
|
Minimal Package on macOS
|
||||||
-----
|
------------------------
|
||||||
|
|
||||||
These instructions assume you're using brew, and have Python and pip set up. If not, see the
|
These instructions assume you're using brew, and have Python and pip set up. If not, see the
|
||||||
`brew docs`_ for help. The main requirements for novelWriter are installed via the requirements
|
`brew docs`_ for help. The main requirements for novelWriter are installed via the requirements
|
||||||
|
|||||||
@@ -8,13 +8,18 @@ You can at any time build a manuscript, an outline of your notes, or any other t
|
|||||||
from the text in your project. All of this is handled by the :guilabel:`Build Novel Project` tool.
|
from the text in your project. All of this is handled by the :guilabel:`Build Novel Project` tool.
|
||||||
You can activate it from the sidebar, the :guilabel:`Tools` menu, or by pressing :kbd:`F5`.
|
You can activate it from the sidebar, the :guilabel:`Tools` menu, or by pressing :kbd:`F5`.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
This tool is scheduled to receive a full update in novelWriter 2.1, adding many new features
|
||||||
|
requested by users. See the `2.1 Milestone <https://github.com/vkbo/novelWriter/milestone/43>`_
|
||||||
|
for an overview.
|
||||||
|
|
||||||
|
|
||||||
.. _a_export_headers:
|
.. _a_export_headers:
|
||||||
|
|
||||||
Header Formatting
|
Header Formatting
|
||||||
=================
|
=================
|
||||||
|
|
||||||
The titles for the five types of titles (the chapter headings come in a numbered and unnumbered
|
The titles for the five types of headings (the chapter headings come in a numbered and unnumbered
|
||||||
version) of story structure can be formatted collectively in the build tool. This is done through
|
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%``.
|
a series of keyword–replace steps. They are all on the format ``%keyword%``.
|
||||||
|
|
||||||
|
|||||||
@@ -13,9 +13,9 @@ The relation between all these additional elements is extracted from the documen
|
|||||||
project indexer, based on the tags and references you set within them.
|
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
|
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
|
tag to them, makes it possible to use the Outline View to see how each element intersects with each
|
||||||
intersects with each section of the novel itself, and adds clickable cross-references between
|
section of the novel itself, and adds clickable cross-references between documents in the editor
|
||||||
documents in the editor and viewer.
|
and viewer.
|
||||||
|
|
||||||
|
|
||||||
.. _a_notes_tags:
|
.. _a_notes_tags:
|
||||||
@@ -24,10 +24,10 @@ Tags in Notes
|
|||||||
=============
|
=============
|
||||||
|
|
||||||
Each new heading in a note can have a tag associated with it. The format of a tag is
|
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
|
``@tag: tagname``, where tagname is a unique identifier of your choosing. Tags can then be
|
||||||
documents, or cross-referenced in other notes, and will show up in the Outline View and in the
|
referenced in the novel documents, or cross-referenced in other notes, and will show up in the
|
||||||
back-reference panel when a document is opened in the viewer. See :ref:`a_struct_tags` for how to
|
Outline View and in the back-reference panel when a document is opened in the viewer. See
|
||||||
reference notes.
|
: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
|
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
|
allowed, that is, the tag is unique. Duplicate tags should be detected as long as the index is up
|
||||||
@@ -39,11 +39,11 @@ is there for the writer to use in whatever way they wish. Of course, the content
|
|||||||
can be added to the manuscript, or an outline document. If you want to compile a single document of
|
can be added to the manuscript, or an outline document. If you want to compile a single document of
|
||||||
all your notes, you can do this from the :guilabel:`Build Novel Project` tool.
|
all your notes, you can do this from the :guilabel:`Build Novel Project` tool.
|
||||||
|
|
||||||
A note can also reference other notes in the same way novel documents do. When the note is opened
|
One note can also reference another note in the same way novel documents do. When the note is
|
||||||
in the view panel, the references become clickable links, making it easier to follow connections in
|
opened in the view panel, the references become clickable links, making it easier to follow
|
||||||
the plot. Notes don't show up in the Outline View though, so referencing between notes is only
|
connections in the plot. Notes don't show up in the Outline View though, so referencing between
|
||||||
meaningful if you want to be able to click-navigate between them, or of course if you just want to
|
notes is only meaningful if you want to be able to click-navigate between them, or of course if you
|
||||||
highlight that two notes are related.
|
just want to highlight that two notes are related.
|
||||||
|
|
||||||
.. tip::
|
.. tip::
|
||||||
If you cross-reference between notes and export your project as an HTML document using the
|
If you cross-reference between notes and export your project as an HTML document using the
|
||||||
|
|||||||
@@ -6,9 +6,10 @@ Novel Projects
|
|||||||
|
|
||||||
New projects can be created from the :guilabel:`Project` menu by selecting :guilabel:`New Project`.
|
New projects can be created from the :guilabel:`Project` menu by selecting :guilabel:`New Project`.
|
||||||
This will open the :guilabel:`New Project Wizard` that will assist you in creating a barebone
|
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
|
project suited to your needs.
|
||||||
files on the local file system. See :ref:`a_storage` for further details on how files are
|
|
||||||
organised.
|
A novelWriter project requires a dedicated folder for storing its files on the local file system.
|
||||||
|
See :ref:`a_storage` for further details on how files are organised.
|
||||||
|
|
||||||
A list of recently opened projects is maintained, and displayed in the :guilabel:`Open Project`
|
A list of recently opened projects is maintained, and displayed in the :guilabel:`Open Project`
|
||||||
dialog. A project can be removed from this list by selecting it and pressing the :kbd:`Del` key or
|
dialog. A project can be removed from this list by selecting it and pressing the :kbd:`Del` key or
|
||||||
@@ -33,23 +34,28 @@ other root folders. These other root folder types are intended for your notes on
|
|||||||
elements of your story. Using them is of course entirely optional.
|
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
|
A new project may not have all of the root folders present, but you can add the ones you want from
|
||||||
the project tree.
|
the project tree tool bar.
|
||||||
|
|
||||||
Each root folder has one or more reference keyword associated with it that can be used to reference
|
Each root folder has one or more reference keyword associated with it that is used to reference
|
||||||
tags in your notes from other documents and notes. The intended usage of each type of root folder
|
them from other documents and notes. The intended usage of each type of root folder is listed
|
||||||
is listed below. However, aside from the :guilabel:`Novel` folder, no restrictions are applied by
|
below. However, aside from the :guilabel:`Novel` folder, no restrictions are applied by the
|
||||||
the application. You can use them however you want.
|
application on what you put in them. You can use them however you want.
|
||||||
|
|
||||||
You can make multiple root folders of each kind.
|
.. tip::
|
||||||
|
You can make multiple root folders of each kind if you wish to split up your notes.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
It is not the notes themselves that are referenced by the listed reference keywords, but tags
|
||||||
|
set within the notes. See the examples below and in :ref:`a_struct_tags`.
|
||||||
|
|
||||||
:guilabel:`Novel`
|
:guilabel:`Novel`
|
||||||
This is the root folder of all text that goes into the final novel. This class of documents have
|
This is the root folder of all text that goes into the final novel or novels. This class of
|
||||||
other rules and features than other documents in the project. See :ref:`a_struct` for more
|
documents have other rules and features than the project notes. See :ref:`a_struct` for more
|
||||||
details.
|
details.
|
||||||
|
|
||||||
:guilabel:`Plot`
|
:guilabel:`Plot`
|
||||||
This is the root folder where main plots can be outlined. It is optional, but adding at least
|
This is the root folder where main plots can be outlined. It is optional, but adding at least
|
||||||
brief notes can be useful in order to tag plot elements for the Outline view. Tags in this
|
brief notes can be useful in order to tag plot elements for the Outline View. Tags in this
|
||||||
folder can be references using the ``@plot`` keyword.
|
folder can be references using the ``@plot`` keyword.
|
||||||
|
|
||||||
:guilabel:`Characters`
|
:guilabel:`Characters`
|
||||||
@@ -84,7 +90,7 @@ You can make multiple root folders of each kind.
|
|||||||
The root folders correspond to the categories of tags that can be used to reference them. For more
|
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`.
|
information about the tags listed, see :ref:`a_struct_tags`.
|
||||||
|
|
||||||
.. tip::
|
.. note::
|
||||||
You can rename root folders to whatever you want. However, this doesn't change the reference
|
You can rename root folders to whatever you want. However, this doesn't change the reference
|
||||||
keyword.
|
keyword.
|
||||||
|
|
||||||
@@ -183,7 +189,7 @@ this warning, and continue opening the project at your own risk.
|
|||||||
the project are in fact open, you are likely to cause inconsistencies and create diverging
|
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
|
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
|
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.
|
novelWriter will try to resolve project inconsistencies the next time you open the project.
|
||||||
|
|
||||||
|
|
||||||
.. _a_proj_roots_dirs:
|
.. _a_proj_roots_dirs:
|
||||||
@@ -211,15 +217,15 @@ documents.
|
|||||||
Project Documents
|
Project Documents
|
||||||
=================
|
=================
|
||||||
|
|
||||||
New documents can be created from tool bar in the Project Tree, or by pressing :kbd:`Ctrl`:kbd:`N`.
|
New documents can be created from the tool bar in the Project Tree, or by pressing
|
||||||
This will open the create new item menu and let you choose between a number of pre-defined
|
:kbd:`Ctrl`:kbd:`N`. This will open the create new item menu and let you choose between a number of
|
||||||
documents and folders. You will be prompted for a label for the new item. You can always rename an
|
pre-defined documents and folders. You will be prompted for a label for the new item. You can
|
||||||
item by selecting :guilabel:`Rename Item` from the :guilabel:`Project` menu, or by pressing
|
always rename an item by selecting :guilabel:`Rename Item` from the :guilabel:`Project` menu, or by
|
||||||
:kbd:`F2`.
|
pressing :kbd:`F2`.
|
||||||
|
|
||||||
Other settings for project items are available from the context menu that you can activate by
|
Other settings for project items are available from the context menu that you can activate by
|
||||||
right-clicking on them inb the Project Tree. The :guilabel:`Transform` submenu includes options for
|
right-clicking on an item in the Project Tree. The :guilabel:`Transform` submenu includes options
|
||||||
converting, splitting, or merging items.
|
for converting, splitting, or merging items.
|
||||||
|
|
||||||
|
|
||||||
.. _a_proj_files_counts:
|
.. _a_proj_files_counts:
|
||||||
@@ -228,7 +234,7 @@ Word Counts
|
|||||||
-----------
|
-----------
|
||||||
|
|
||||||
A character, word and paragraph count is maintained for each document, as well as for each section
|
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
|
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
|
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.
|
panel below the project tree for any document selected in the project or novel tree.
|
||||||
|
|
||||||
@@ -257,9 +263,9 @@ The :guilabel:`Settings` tab holds the project name, title, and author settings.
|
|||||||
|
|
||||||
The :guilabel:`Project Name` can be set to a different value than the :guilabel:`Novel Title`. The
|
The :guilabel:`Project Name` can be set to a different value than the :guilabel:`Novel Title`. The
|
||||||
difference between them is simply that the :guilabel:`Project Name` is used for the GUI (main
|
difference between them is simply that the :guilabel:`Project Name` is used for the GUI (main
|
||||||
window title) and for generating the backup files. The intention is that the :guilabel:`Project
|
window title) and for generating the backup files. The intention is that the
|
||||||
Name` should remain unchanged throughout the project, otherwise the name of exported files and
|
:guilabel:`Project Name` should remain unchanged throughout the project's lifetime, otherwise the
|
||||||
backup files may change too.
|
name of exported files and backup files may change too.
|
||||||
|
|
||||||
The :guilabel:`Novel Title` and :guilabel:`Authors` settings are used when building the manuscript,
|
The :guilabel:`Novel Title` and :guilabel:`Authors` settings are used when building the manuscript,
|
||||||
for some formats.
|
for some formats.
|
||||||
@@ -272,8 +278,8 @@ setting.
|
|||||||
Status and Importance Tabs
|
Status and Importance Tabs
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
Each document or folder of type :guilabel:`Novel` can be given a _Status_ label accompanied by a
|
Each document or folder of type :guilabel:`Novel` can be given a *Status*_* label accompanied by a
|
||||||
coloured icon, and each document or folder of the remaining types can be given an _Importance_
|
coloured icon, and each document or folder of the remaining types can be given an *Importance*
|
||||||
label.
|
label.
|
||||||
|
|
||||||
These are purely there for the user's convenience, and you are not required to use them for any
|
These are purely there for the user's convenience, and you are not required to use them for any
|
||||||
@@ -297,7 +303,7 @@ will be replaced by the text in the right column when documents are opened in th
|
|||||||
also be applied to manuscript builds.
|
also be applied to manuscript builds.
|
||||||
|
|
||||||
The auto-replace feature will replace text in angle brackets that are in this list. The syntax
|
The auto-replace feature will replace text in angle brackets that are in this list. The syntax
|
||||||
highlighter will add an alternate colour to text marching the syntax, but it doesn't check if the
|
highlighter will add an alternate colour to text matching the syntax, but it doesn't check if the
|
||||||
text is in this list.
|
text is in this list.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
@@ -336,13 +342,14 @@ Writing Statistics
|
|||||||
==================
|
==================
|
||||||
|
|
||||||
When you work on a project, a log file records when you opened it, when you closed it, and the
|
When you work on a project, a log file records when you opened it, when you closed it, and the
|
||||||
total word counts of your novel documents and notes at the end of the session provided that the
|
total word counts of your novel documents and notes at the end of the session, provided that the
|
||||||
session lasted either more than 5 minutes, or that the total word count changed. You can view this
|
session lasted either more than 5 minutes, or that the total word count changed. You can view this
|
||||||
file in the ``meta`` folder in the directory where you saved your project. The file is named
|
file in the ``meta`` folder in the directory where you saved your project. The file is named
|
||||||
``sessionStats.log``.
|
``sessionStats.log``.
|
||||||
|
|
||||||
A tool to view the content of this file is available in the :guilabel:`Tools` menu under
|
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`.
|
:guilabel:`Writing Statistics`. You can also launch it by pressing :kbd:`F6`, or find it on the
|
||||||
|
Sidebar.
|
||||||
|
|
||||||
The tool will show a list of all your sessions, and a set of filters to apply to the data. You can
|
The tool will show a list of all your sessions, and a set of filters to apply to the data. You can
|
||||||
also export the filtered data to a JSON file or to a CSV file that can be opened by a spreadsheet
|
also export the filtered data to a JSON file or to a CSV file that can be opened by a spreadsheet
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ The syntax for the four basic header types, and the two special header types, is
|
|||||||
This header level signifies a sub-scene level partition, usually called a "section" in the
|
This header level signifies a sub-scene level partition, usually called a "section" in the
|
||||||
documentation and the user interface. These can be useful if you want to change tag references
|
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
|
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.
|
wish, and you can filter them out of the final manuscript just like with scene titles.
|
||||||
|
|
||||||
Page breaks are automatically added before level 1 and 2 headers when you build your project to a
|
Page breaks are automatically added before level 1 and 2 headers when you build your project to a
|
||||||
format that supports page breaks, or when you print the document directly from the build tool. If
|
format that supports page breaks, or when you print the document directly from the build tool. If
|
||||||
@@ -80,7 +80,7 @@ for instance the author's name and details.
|
|||||||
|
|
||||||
If you want an additional page of text after the title page, starting on a fresh page, you can add
|
If you want an additional page of text after the title page, starting on a fresh page, you can add
|
||||||
``[NEW PAGE]`` on a line by itself, and continue the text after it. This will insert a page break
|
``[NEW PAGE]`` on a line by itself, and continue the text after it. This will insert a page break
|
||||||
before the text.
|
before the text. See also :ref:`a_fmt_break`.
|
||||||
|
|
||||||
|
|
||||||
.. _a_struct_heads_unnum:
|
.. _a_struct_heads_unnum:
|
||||||
@@ -124,42 +124,42 @@ below. The format of a reference line is ``@keyword: value1, [value2] ... [value
|
|||||||
allow multiple values.
|
allow multiple values.
|
||||||
|
|
||||||
``@pov``
|
``@pov``
|
||||||
The point-of-view character for the current section. The target must be a note tag in the
|
The point-of-view character for the current section. The target must be a note tag in a
|
||||||
:guilabel:`Character` type root folder.
|
:guilabel:`Character` type root folder.
|
||||||
|
|
||||||
``@focus``
|
``@focus``
|
||||||
The character that has the focus for the current section. This can be used in cases where the
|
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
|
focus is not a point-of-view character. The target must be a note tag in a :guilabel:`Character`
|
||||||
:guilabel:`Character` type root folder.
|
type root folder.
|
||||||
|
|
||||||
``@char``
|
``@char``
|
||||||
Other characters in the current section. The target must be a note tag in the
|
Other characters in the current section. The target must be a note tag in a
|
||||||
:guilabel:`Character` type root folder. This should not include the point-of-view character.
|
:guilabel:`Character` type root folder. This should not include the point-of-view or focus
|
||||||
|
character if those references are used.
|
||||||
|
|
||||||
``@plot``
|
``@plot``
|
||||||
The plot or subplot advanced in the current section. The target must be a note tag in the
|
The plot or subplot advanced in the current section. The target must be a note tag in a
|
||||||
:guilabel:`Plot` type root folder.
|
:guilabel:`Plot` type root folder.
|
||||||
|
|
||||||
``@time``
|
``@time``
|
||||||
The timelines touched by the current section. The target must be a note tag in the
|
The timelines touched by the current section. The target must be a note tag in a
|
||||||
:guilabel:`Timeline` type root folder.
|
:guilabel:`Timeline` type root folder.
|
||||||
|
|
||||||
``@location``
|
``@location``
|
||||||
The location the current section takes place in. The target must be a note tag in the
|
The location the current section takes place in. The target must be a note tag in a
|
||||||
:guilabel:`Locations` type root folder.
|
:guilabel:`Locations` type root folder.
|
||||||
|
|
||||||
``@object``
|
``@object``
|
||||||
Objects present in the current section. The target must be a note tag in the :guilabel:`Object`
|
Objects present in the current section. The target must be a note tag in a :guilabel:`Object`
|
||||||
type root folder.
|
type root folder.
|
||||||
|
|
||||||
``@entity``
|
``@entity``
|
||||||
Entities present in the current section. The target must be a note tag in the
|
Entities present in the current section. The target must be a note tag in a
|
||||||
:guilabel:`Entities` type root folder.
|
:guilabel:`Entities` type root folder.
|
||||||
|
|
||||||
``@custom``
|
``@custom``
|
||||||
Custom references in the current section. The target must be a note tag in a :guilabel:`Custom`
|
Custom references in the current section. The target must be a note tag in a :guilabel:`Custom`
|
||||||
type root folder. You can add more than one Custom folder, but they all use the same reference
|
type root folder. The custom folder are for any other category of notes you may want to use.
|
||||||
keyword.
|
|
||||||
|
|
||||||
The syntax highlighter will alert the user that the tags and references are used correctly, and
|
The syntax highlighter will alert the user that the tags and references are used correctly, and
|
||||||
that the tags referenced exist.
|
that the tags referenced exist.
|
||||||
@@ -204,5 +204,5 @@ For novel documents, the heading level of the first heading is recorded, and ind
|
|||||||
|
|
||||||
.. tip::
|
.. tip::
|
||||||
You can always start writing with a coarse setup with one or a few documents, and then later use
|
You can always start writing with a coarse setup 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 to split the documents into separate chapter and scene documents. You can split a
|
||||||
You can split a document on any of the four header levels.
|
document on any of the four header levels.
|
||||||
|
|||||||
@@ -39,8 +39,8 @@ Application Data
|
|||||||
================
|
================
|
||||||
|
|
||||||
novelWriter also stores a bit of data that is generated by the user's actions. This includes the
|
novelWriter also stores a bit of data that is generated by the user's actions. This includes the
|
||||||
list of recent projects form the :guilabel:`Open Project` dialog. Custom themes are also saved
|
list of recent projects form the :guilabel:`Open Project` dialog. Custom themes should also be
|
||||||
here. The system paths are provided by the Qt QStandardPaths_ class and its AppDataLocation.
|
saved here. The system paths are provided by the Qt QStandardPaths_ class and its AppDataLocation.
|
||||||
|
|
||||||
The standard paths are:
|
The standard paths are:
|
||||||
|
|
||||||
|
|||||||
@@ -13,14 +13,14 @@ Project Structure
|
|||||||
All novelWriter files are written with utf-8 encoding. Since Python automatically converts Unix
|
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
|
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.
|
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
|
Python also handles this when working on the same files on both Windows and Unix-based operating
|
||||||
operating systems.
|
systems.
|
||||||
|
|
||||||
|
|
||||||
Main Project File
|
Main Project File
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
The project itself requires a dedicated folder for storing its files where novelWriter will create
|
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
|
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
|
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.
|
also contains all the meta data required for the project, and a number of related project settings.
|
||||||
@@ -33,7 +33,7 @@ your own backup solution.
|
|||||||
The novelWriter project folder is structured so that it can easily be added to a version control
|
The novelWriter project folder is structured so that it can easily be added to a version control
|
||||||
system like git. If you do so, you may want to add a `.gitignore` file to exclude files with the
|
system like git. If you do so, you may want to add a `.gitignore` file to exclude files with the
|
||||||
extensions `.json` as JSON files are used to cache the index and various run-time settings and
|
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.
|
are generally large files that change often.
|
||||||
|
|
||||||
The project XML file is indent-formatted, and is suitable for diff tools and version control since
|
The project XML file is indent-formatted, and is suitable for diff tools and version control since
|
||||||
most of the file will stay static, although a timesetamp is set in the meta section on line 2, and
|
most of the file will stay static, although a timesetamp is set in the meta section on line 2, and
|
||||||
@@ -44,9 +44,8 @@ Project Documents
|
|||||||
=================
|
=================
|
||||||
|
|
||||||
All the project documents are saved in a folder in the main project folder named ``content``. Each
|
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
|
document has a file handle based on a 52 bit random number, represented as a hexadecimal string.
|
||||||
when the document was first created, plus an incremented number. The documents are saved with a
|
The documents are saved with a filename assembled from this handle and the file extension ``.nwd``.
|
||||||
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
|
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
|
up in the project XML file, select :guilabel:`Show File Details` from the :guilabel:`Document` menu
|
||||||
@@ -56,7 +55,8 @@ where they are saved.
|
|||||||
|
|
||||||
The reason for this cryptic file naming is to avoid issues with file naming conventions and
|
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
|
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.
|
what the user names the document within the project, or changes it to. This is particularly useful
|
||||||
|
when using a versioning system.
|
||||||
|
|
||||||
Each document file contains a plain text version of the text from the editor. The file can in
|
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
|
principle be edited in any text editor, and is suitable for diffing and version control if so
|
||||||
@@ -98,8 +98,8 @@ folder contains semi-important files. That is, they can be lost with only minor
|
|||||||
project.
|
project.
|
||||||
|
|
||||||
If you use version control software on your project, you can exclude this folder, although you may
|
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
|
want to track the session log file and the custom words list. The JSON files within this folder can
|
||||||
will be automatically regenerated if lost.
|
safely be ignored as they will be automatically regenerated if lost.
|
||||||
|
|
||||||
|
|
||||||
The Project Index
|
The Project Index
|
||||||
@@ -131,6 +131,14 @@ The file is not critical, but if it is lost, all such GUI options will revert ba
|
|||||||
settings.
|
settings.
|
||||||
|
|
||||||
|
|
||||||
|
Custom Word List
|
||||||
|
----------------
|
||||||
|
|
||||||
|
A file named ``meta/wordlist.txt`` contains all the custom words you've added to the project for
|
||||||
|
spell checking purposes. The content of the file can be edited from the :guilabel:`Tools` menu. If
|
||||||
|
you lose this file, all your custom spell check words will be lost too.
|
||||||
|
|
||||||
|
|
||||||
Session Stats
|
Session Stats
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
@@ -147,4 +155,5 @@ The project ``cache`` folder contains non-critical files. If these files are los
|
|||||||
impact on the functionality of novelWriter or the history of the project. It contains temporary
|
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.
|
files, like the preview document in the :guilabel:`Build Novel Project` tool.
|
||||||
|
|
||||||
It should be excluded from version control tools if such are used.
|
It should be excluded from version control tools if such are used. The folder will be removed
|
||||||
|
entirely in novelWriter 2.1.
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ The dependencies for running the tests can be installed with:
|
|||||||
pip install -r requirements-dev.txt
|
pip install -r requirements-dev.txt
|
||||||
|
|
||||||
This will install a couple of extra packages for coverage and test management. The minimum
|
This will install a couple of extra packages for coverage and test management. The minimum
|
||||||
requirement is just ``pytest`` and ``pytest-qt``.
|
requirement is ``pytest`` and ``pytest-qt``.
|
||||||
|
|
||||||
|
|
||||||
Simple Test Run
|
Simple Test Run
|
||||||
|
|||||||
@@ -4,11 +4,14 @@
|
|||||||
How it Works
|
How it Works
|
||||||
************
|
************
|
||||||
|
|
||||||
|
.. _Fusion: https://doc.qt.io/qt-6/gallery.html
|
||||||
|
.. _Pandoc: https://pandoc.org/
|
||||||
.. _Typicons: https://github.com/stephenhutchings/typicons.font
|
.. _Typicons: https://github.com/stephenhutchings/typicons.font
|
||||||
|
.. _Open Document: https://en.wikipedia.org/wiki/OpenDocument
|
||||||
|
|
||||||
The main features of novelWriter are listed in the :ref:`a_intro` section. Here, we go into some
|
The main features of novelWriter are listed in the :ref:`a_intro` section. Here, we go into some
|
||||||
more details on how they are implemented. Later on in this documentation, these features will be
|
more details on how they are implemented. This is intended as an overview. Later on in this
|
||||||
covered in even more detail.
|
documentation, these features will be covered in even more detail.
|
||||||
|
|
||||||
|
|
||||||
.. _a_breakdown_design:
|
.. _a_breakdown_design:
|
||||||
@@ -22,8 +25,8 @@ at the same time provide a complete set of features needed for writing a novel.
|
|||||||
The main window does not have an editor toolbar like many other applications do. This reduces
|
The main window does not have an editor toolbar like many other applications do. This reduces
|
||||||
clutter, and since the documents are formatted with style tags, is more or less redundant. However,
|
clutter, and since the documents are formatted with style tags, is more or less redundant. However,
|
||||||
most formatting features supported are available through convenient keyboard shortcuts. They are
|
most formatting features supported are available through convenient keyboard shortcuts. They are
|
||||||
alsoavailable in the main menu so you don't have to look up formatting codes every time you need
|
also available in the main menu so you don't have to look up formatting codes every time you need
|
||||||
them. However, a list of all shortcuts can be found in the :ref:`a_kb` section.
|
them. For reference, a list of all shortcuts can be found in the :ref:`a_kb` section.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
novelWriter is not intended to be a full office type word processor. It doesn't support images,
|
novelWriter is not intended to be a full office type word processor. It doesn't support images,
|
||||||
@@ -40,32 +43,43 @@ Project Tree View
|
|||||||
|
|
||||||
When in :guilabel:`Project Tree View` mode, the main work area of the main window is split in two,
|
When in :guilabel:`Project Tree View` mode, the main work area of the main window is split in two,
|
||||||
or optionally three, panels. The left-most panel contains the project tree and all the documents in
|
or optionally three, panels. The left-most panel contains the project tree and all the documents in
|
||||||
your project. The second panel is the document editor. An optional third panel is a document viewer
|
your project. The second panel is the document editor. An optional third panel on the right is a
|
||||||
which can view any document in your project independently of what is open in the document editor.
|
document viewer which can view any document in your project independently of what is open in the
|
||||||
It is not intended as a preview window, although you can use it for this as well as it will apply
|
document editor. This panel is not intended as a preview window, although you can use it for this
|
||||||
the formatting tags you have specified. The main purpose of the viewer is for viewing your notes
|
if you wish as it will apply the formatting tags you have specified. The main purpose of the viewer
|
||||||
next to your editor while you're writing.
|
is for viewing your notes next to your editor while you're writing.
|
||||||
|
|
||||||
The editor also has a :guilabel:`Focus Mode` you can toggle either from the menu, or from the icon
|
The editor also has a :guilabel:`Focus Mode` you can toggle either from the menu, from the icon in
|
||||||
in the editor header. When :guilabel:`Focus Mode` is enabled, all the user interface elements other
|
the editor header, or by pressing :kbd:`F8`. When :guilabel:`Focus Mode` is enabled, all the user
|
||||||
than the document editor itself are hidden away.
|
interface elements other than the document editor itself are hidden away.
|
||||||
|
|
||||||
|
|
||||||
Novel Tree View
|
Novel Tree View
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
When in :guilabel:`Novel Tree View` mode, the project tree is replaces by an overview of your novel
|
When in :guilabel:`Novel Tree View` mode, the project tree is replaces by an overview of your novel
|
||||||
structure. Instead of showing individual documents, the tree shows all headings of your novel text.
|
structure. Instead of showing individual documents, the tree now shows all headings of your novel
|
||||||
|
text. This includes multiple headings within the same document.
|
||||||
|
|
||||||
Each heading is indented according to the heading level. You can open and edit your novel documents
|
Each heading is indented according to the heading level. You can open and edit your novel documents
|
||||||
from this view as well. All headings contained in the currently open document should be highlighted
|
from this view as well. All headings contained in the currently open document should be highlighted
|
||||||
in the view.
|
in the view to indicate which ones belong together.
|
||||||
|
|
||||||
If you have multiple Novel root folders, you can switch between them from the dropdown menu from
|
If you have multiple Novel root folders, the header of the novel view becomes a droopdown box. You
|
||||||
the buttons at the top of the tree view. You can also select to view an extra column of data. To
|
can then switch between them by clicking the "Outline of ..." text. You can also click the novel
|
||||||
select its content, see the menu icon button.
|
icon button next to it.
|
||||||
|
|
||||||
If you click the arrow to the right of each item, a tooltip will pop up showing you all the meta
|
Generally, the novel view should update when you make changes to the novel structure, including
|
||||||
data collected for that heading entry.
|
edits of the current document in the editor. The information is only updated when the automatic
|
||||||
|
save of the document is initiated though. You can adjust the aut-save interval in
|
||||||
|
:guilabel:`Preferences`. You can also regenerate the whole novel view by pressing the refresh
|
||||||
|
button at the top.
|
||||||
|
|
||||||
|
It is possible to show an optional third column in the novel view, The settings are available from
|
||||||
|
the menu button ath the top.
|
||||||
|
|
||||||
|
If you click the arrow icon to the right of each item, a tooltip will pop up showing you all the
|
||||||
|
meta data collected for that heading entry.
|
||||||
|
|
||||||
|
|
||||||
Novel Outline View
|
Novel Outline View
|
||||||
@@ -77,22 +91,26 @@ much all collected meta data is available here in different columns.
|
|||||||
|
|
||||||
You can select which novel root folder to display from the dropdown box, and you can select which
|
You can select which novel root folder to display from the dropdown box, and you can select which
|
||||||
columns to show or hide from the menu button. You can also rearrange the columns by drag and drop.
|
columns to show or hide from the menu button. You can also rearrange the columns by drag and drop.
|
||||||
|
The app will remember you column order and size between sessions, and for each individual project.
|
||||||
|
|
||||||
|
|
||||||
Colour Themes
|
Colour Themes
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
The default colour theme of the user interface is the default theme from the Qt library. There is a
|
The default colour theme of the user interface is the default theme from the Qt library. By
|
||||||
standard dark theme provided as well, which is similar to the default Qt theme. Some other light
|
default, novelWriter is loaded with the Fusion_ style setting. (You can override this with the
|
||||||
and dark colour themes are also provided. You can select which one you prefer from in
|
``--style=`` setting when starting novelWriter.)
|
||||||
:guilabel:`Preferences` from :guilabel:`Settings` or the :guilabel:`Tools` menu.
|
|
||||||
|
There is a standard dark theme provided as well, which is similar to the default Qt theme. Some
|
||||||
|
other light and dark colour themes are also provided. You can select which one you prefer from in
|
||||||
|
:guilabel:`Preferences` .
|
||||||
|
|
||||||
A number of syntax highlighting themes are also available in :guilabel:`Preferences`. These are
|
A number of syntax highlighting themes are also available in :guilabel:`Preferences`. These are
|
||||||
separate settings because there are a lot more options for syntax highlighting.
|
separate settings because there are a lot more options for syntax highlighting.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
If you switch to dark mode on the GUI, you should also switch the icon theme and syntax
|
If you switch to dark mode on the GUI, you should also switch syntax highlighting theme to
|
||||||
highlighting theme, otherwise icons may be hard to see.
|
match, otherwise icons may be hard to see in the editor and viewer.
|
||||||
|
|
||||||
|
|
||||||
.. _a_breakdown_project:
|
.. _a_breakdown_project:
|
||||||
@@ -124,8 +142,8 @@ the header levels have no structural meaning, and the user is free to do whateve
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
You can add documents as child items of other documents if you wish. This is often more useful
|
You can add documents as child items of other documents if you wish. This is often more useful
|
||||||
than adding folders, since you may want to have the chapter heading in a separate document from
|
than adding folders, since you anyway may want to have the chapter heading in a separate
|
||||||
your individual scene documents.
|
document from your individual scene documents.
|
||||||
|
|
||||||
|
|
||||||
.. _a_breakdown_export:
|
.. _a_breakdown_export:
|
||||||
@@ -134,10 +152,10 @@ Building the Manuscript
|
|||||||
=======================
|
=======================
|
||||||
|
|
||||||
The project can at any time be assembled into a range of different formats through the
|
The project can at any time be assembled into a range of different formats through the
|
||||||
:guilabel:`Build Novel Project` tool. Natively, novelWriter supports Open Document, HTML5, and
|
:guilabel:`Build Novel Project` tool. Natively, novelWriter supports `Open Document`_, HTML5, and
|
||||||
various flavours of Markdown.
|
various flavours of Markdown.
|
||||||
|
|
||||||
The HTML5 format is suitable for conversion by a number of other tools like Pandoc, or for
|
The HTML5 format is suitable for conversion by a number of other tools like Pandoc_, or for
|
||||||
importing into word processors if the Open Document format isn't suitable. In addition, printing
|
importing into word processors if the Open Document format isn't suitable. In addition, printing
|
||||||
and printing to PDF is also possible.
|
and printing to PDF is also possible.
|
||||||
|
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ Formatting Your Text
|
|||||||
|
|
||||||
The novelWriter text editor is a plain text editor that uses formatting codes for setting meta data
|
The novelWriter text editor is a plain text editor that uses formatting codes for setting meta data
|
||||||
values and allowing for some text formatting. The syntax is based on Markdown, but novelWriter is
|
values and allowing for some text formatting. The syntax is based on Markdown, but novelWriter is
|
||||||
*not* strictly a Markdown editor. It supports basic formatting like emphasis (italic), strong
|
*not* a Markdown editor. It supports basic formatting like emphasis (italic), strong importance
|
||||||
importance (bold) and strikethrough text, as well as four levels of headings.
|
(bold) and strikethrough text, as well as four levels of headings.
|
||||||
|
|
||||||
In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a set of
|
In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a set of
|
||||||
keyword and value sets used for tags and references. There are also some codes that apply two whole
|
keyword and value sets used for tags and references. There are also some codes that apply two whole
|
||||||
@@ -26,7 +26,7 @@ dialogue in your text.
|
|||||||
|
|
||||||
When you use the commands to set tags and references, these also change colour. Correct commands
|
When you use the commands to set tags and references, these also change colour. Correct commands
|
||||||
have a dedicated colour, and the references themselves will get a colour if they are valid. Invalid
|
have a dedicated colour, and the references themselves will get a colour if they are valid. Invalid
|
||||||
references will get a squiggly error line underneath.
|
references will get a squiggly error line underneath. The same applies to duplicate tags.
|
||||||
|
|
||||||
There are a number of syntax highlighter colour themes available, both for light and dark GUIs. You
|
There are a number of syntax highlighter colour themes available, both for light and dark GUIs. You
|
||||||
can select them for :guilabel:`Preferences`.
|
can select them for :guilabel:`Preferences`.
|
||||||
@@ -173,10 +173,10 @@ altering the colour of the word.
|
|||||||
Tags and References
|
Tags and References
|
||||||
===================
|
===================
|
||||||
|
|
||||||
The document editor supports a minimal set of keywords used for setting tags, and making references
|
The document editor supports a set of keywords used for setting tags, and making references between
|
||||||
between documents. The tag can be set once per section defined by a heading. Setting it multiple
|
documents. The tag can be set once per section defined by a heading. Setting it multiple times
|
||||||
times under the same heading will just override the previous setting. References can be set
|
under the same heading will just override the previous setting. References can be set anywhere
|
||||||
anywhere within a section, and are collected according to their category.
|
within a section, and are collected according to their category.
|
||||||
|
|
||||||
``@keyword: value``
|
``@keyword: value``
|
||||||
A keyword argument followed by a value, or a comma separated list of values.
|
A keyword argument followed by a value, or a comma separated list of values.
|
||||||
@@ -208,12 +208,12 @@ Examples:
|
|||||||
:widths: 40, 60
|
:widths: 40, 60
|
||||||
:class: "tight-table"
|
:class: "tight-table"
|
||||||
|
|
||||||
"``>> Right aligned text``", "The text paragraph is right-aligned."
|
"``>> Right aligned text``", "The text paragraph is right-aligned."
|
||||||
"``Left aligned text <<``", "The text paragraph is left-aligned."
|
"``Left aligned text <<``", "The text paragraph is left-aligned."
|
||||||
"``>> Centred text <<``", "The text paragraph is centred."
|
"``>> Centred text <<``", "The text paragraph is centred."
|
||||||
"``> Indented text``", "The text has an increased left margin."
|
"``> Left indented text``", "The text has an increased left margin."
|
||||||
"``Indented text <``", "The text has an increased right margin."
|
"``Right indented text <``", "The text has an increased right margin."
|
||||||
"``> Indented text <``", "The text has an both margins increased."
|
"``> Left/right indented text <``", "The text has an both margins increased."
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The text editor will not show the alignment and indentation live. But the viewer will show them
|
The text editor will not show the alignment and indentation live. But the viewer will show them
|
||||||
|
|||||||
@@ -27,8 +27,8 @@ the project, and has four columns:
|
|||||||
|
|
||||||
**Column 2**
|
**Column 2**
|
||||||
The second column shows the word count of the document, or the sum of words of the child items
|
The second column shows the word count of the document, or the sum of words of the child items
|
||||||
for folders. If the counts seem incorrect, they can be updated by rebuilding the project index
|
for folders and documents with subdocuments. If the counts seem incorrect, they can be updated
|
||||||
from the :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
|
by rebuilding the project index from the :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
|
||||||
|
|
||||||
**Column 3**
|
**Column 3**
|
||||||
The third column indicates whether the document is considered active or inactive in the project.
|
The third column indicates whether the document is considered active or inactive in the project.
|
||||||
@@ -47,10 +47,10 @@ a selection of actions that can be performed on the selected item.
|
|||||||
At the top of the tree, you will find a set of buttons.
|
At the top of the tree, you will find a set of buttons.
|
||||||
|
|
||||||
* The first button is a quick links button that will show you a dropdown menu of all the root
|
* The first button is a quick links button that will show you a dropdown menu of all the root
|
||||||
folders in your project. Selecting one will scroll to that position in the tree. You can also
|
folders in your project. Selecting one will move to that position in the tree. You can also
|
||||||
activate this menu by pressing :kbd:`Ctrl`:kbd:`L`.
|
activate this menu by pressing :kbd:`Ctrl`:kbd:`L`.
|
||||||
* The next buttons can be used to move items up and down in the project tree. This is the only way
|
* The next two buttons can be used to move items up and down in the project tree. This is the only
|
||||||
to move root folders.
|
way to move root folders.
|
||||||
* The next button opens a dropdown menu for adding new items to the tree. This includes root
|
* The next button opens a dropdown menu for adding new items to the tree. This includes root
|
||||||
folders. You can also activate this dropdown menu by pressing :kbd:`Ctrl`:kbd:`N`.
|
folders. You can also activate this dropdown menu by pressing :kbd:`Ctrl`:kbd:`N`.
|
||||||
* The last button is a menu of further actions on the entire project tree.
|
* The last button is a menu of further actions on the entire project tree.
|
||||||
@@ -78,8 +78,8 @@ the story itself rather than the document files.
|
|||||||
.. note::
|
.. note::
|
||||||
You cannot reorganise the entries in the novel tree, or add any new documents, as that would
|
You cannot reorganise the entries in the novel tree, or add any new documents, as that would
|
||||||
imply restructuring the content of the document files. Any editing must be done in the project
|
imply restructuring the content of the document files. Any editing must be done in the project
|
||||||
tree. However, you can add new headings to existing documents, which will be updated in this
|
tree. However, you can add new headings to existing documents, or change references, which will
|
||||||
view.
|
be updated in this view.
|
||||||
|
|
||||||
|
|
||||||
.. _a_ui_tree_status:
|
.. _a_ui_tree_status:
|
||||||
@@ -88,8 +88,8 @@ Document Importance and Status
|
|||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
Each document or folder in your project can have either a "Status" or "Importance" flag set. These
|
Each document or folder in your project can have either a "Status" or "Importance" flag set. These
|
||||||
are flags that you control and define yourself. To modify the labels, go to their respective tabs
|
are flags that you control and define yourself. The app doesn't do anything with them at all. To
|
||||||
in :guilabel:`Project Settings`.
|
modify the labels, go to their respective tabs in :guilabel:`Project Settings`.
|
||||||
|
|
||||||
The "Status" flag is intended to tag a Novel document as for instance a draft or as completed, and
|
The "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,
|
the "Importance" flag is intended to tag character notes, or other notes, as for instance a main,
|
||||||
@@ -105,9 +105,9 @@ If it's in the :guilabel:`Novel` folder, it uses the "Status" flag, otherwise it
|
|||||||
Project Tree Drag & Drop
|
Project Tree Drag & Drop
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
The project tree allows drag & drop to a certain extent. This feature is primarily intended for
|
The project tree allows drag & drop to a certain extent to allow you to reorder your documents and
|
||||||
reordering your documents within each root folder. Moving a document in the project tree will also
|
folders. Moving a document in the project tree will affect the text's position when you assemble
|
||||||
put it in a different place when you build the novel project.
|
your manuscript in the build tool.
|
||||||
|
|
||||||
Drag & drop has only limited support for moving documents. In general, bulk actions are not
|
Drag & drop has only limited support for moving documents. In general, bulk actions are not
|
||||||
allowed. This is deliberate to avoid accidentally messing up your project. If you make a mistake,
|
allowed. This is deliberate to avoid accidentally messing up your project. If you make a mistake,
|
||||||
@@ -115,9 +115,10 @@ the last move action can be undone by pressing :kbd:`Ctrl`:kbd:`Shift`:kbd:`Z`.
|
|||||||
|
|
||||||
Documents and their folders can be rearranged freely within their root folders. If you move a Novel
|
Documents and their folders can be rearranged freely within their root folders. If you move a Novel
|
||||||
documents out of a Novel folder, it will be converted to a project note. Notes can be moved freely
|
documents out of a Novel folder, it will be converted to a project note. Notes can be moved freely
|
||||||
between all root folders, but keep in mind that if you move a note into a :guilabel:`Novel`, its
|
between all root folders, but keep in mind that if you move a note into a :guilabel:`Novel` root
|
||||||
"Importance" setting will be switched with a "Status" setting. See :ref:`a_ui_tree_status`. The old
|
folder, its "Importance" setting will be switched with a "Status" setting. See
|
||||||
value will not be overwritten though, and should be restored if you move it back.
|
:ref:`a_ui_tree_status`. The old value will not be overwritten though, and should be restored if
|
||||||
|
you move it back at some point.
|
||||||
|
|
||||||
Root folders in the project tree cannot be dragged & dropped at all. If you want to reorder them,
|
Root folders in the project tree cannot be dragged & dropped at all. If you want to reorder them,
|
||||||
you can move them up or down with respect to eachother from the arrow buttons at the top of the
|
you can move them up or down with respect to eachother from the arrow buttons at the top of the
|
||||||
@@ -162,8 +163,8 @@ pressing :kbd:`Ctrl`:kbd:`Return`. You can also control-click them with your mou
|
|||||||
the references become clickable links. Clicking them will replace the content of the viewer with
|
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 content of the document the reference points to.
|
||||||
|
|
||||||
The document viewer keeps a history of viewed documents, which you can navigate through with the
|
The document viewer keeps a history of viewed documents, which you can navigate with the arrow
|
||||||
arrow buttons in the top–left corner of the viewer. If your mouse has back and forward navigation
|
buttons in the top–left corner of the viewer. If your mouse has backward and forward navigation
|
||||||
buttons, these can be used as well. They work just like the backward and forward features in a
|
buttons, these can be used as well. They work just like the backward and forward features in a
|
||||||
browser.
|
browser.
|
||||||
|
|
||||||
@@ -254,7 +255,7 @@ to show a combination of all novel folders.
|
|||||||
Various meta data and information extracted from tags can be displayed in columns in the outline.
|
Various meta data and information extracted from tags can be displayed in columns in the outline.
|
||||||
A default set of such columns is visible, but you can turn on or off more columns from the menu
|
A default set of such columns is visible, but you can turn on or off more columns from the menu
|
||||||
button in the toolbar. The order of the columns can also be rearranged by dragging them to a
|
button in the toolbar. The order of the columns can also be rearranged by dragging them to a
|
||||||
different position.
|
different position. You column settings are saved between sessions on a per-project basis.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The :guilabel:`Title` column cannot be disabled or moved.
|
The :guilabel:`Title` column cannot be disabled or moved.
|
||||||
|
|||||||
@@ -43,9 +43,10 @@ Format 1.5 Changes
|
|||||||
This project format was introduced in novelWriter version 2.0 RC 2.
|
This project format was introduced in novelWriter version 2.0 RC 2.
|
||||||
|
|
||||||
This is a modification of the 1.4 format. It makes the XML more consistent in that meta data have
|
This is a modification of the 1.4 format. It makes the XML more consistent in that meta data have
|
||||||
been moved to the section nodes, and key/value settings now have a consistent format. Logical flags
|
been moved to their respective section nodes as attributes, and key/value settings now have a
|
||||||
are saved as yes/no instead of Python True/False, and the main heading of the document is now saved
|
consistent format. Logical flags are saved as yes/no instead of Python True/False, and the main
|
||||||
to the item rather than in the index.
|
heading of the document is now saved to the item rather than in the index. The conversion is done
|
||||||
|
automatically the first time a project is loaded. No user action is required.
|
||||||
|
|
||||||
|
|
||||||
.. _a_prjfmt_1_4:
|
.. _a_prjfmt_1_4:
|
||||||
|
|||||||
@@ -4,7 +4,8 @@
|
|||||||
Keyboard Shortcuts
|
Keyboard Shortcuts
|
||||||
******************
|
******************
|
||||||
|
|
||||||
Most features in novelWriter are available as keyboard shortcuts.
|
Most features in novelWriter are available as keyboard shortcuts. This is a reference list if these
|
||||||
|
shortcuts. Most of them are also listed in the application.
|
||||||
|
|
||||||
|
|
||||||
.. _a_kb_main:
|
.. _a_kb_main:
|
||||||
@@ -16,9 +17,19 @@ The main shorcuts are as follows:
|
|||||||
|
|
||||||
.. csv-table:: Keyboard Shortcuts
|
.. csv-table:: Keyboard Shortcuts
|
||||||
:header: "Shortcut", "Description"
|
:header: "Shortcut", "Description"
|
||||||
:widths: 20, 80
|
:widths: 22, 78
|
||||||
:class: "tight-table"
|
:class: "tight-table"
|
||||||
|
|
||||||
|
":kbd:`F1`", "Open the online user manual."
|
||||||
|
":kbd:`F2`", "If in the project tree, edit an item's label."
|
||||||
|
":kbd:`F3`", "Find next occurrence of search word in current document."
|
||||||
|
":kbd:`F5`", "Open the :guilabel:`Build Novel Project` dialog."
|
||||||
|
":kbd:`F6`", "Open the :guilabel:`Writing Statistics` dialog."
|
||||||
|
":kbd:`F7`", "Re-run spell checker."
|
||||||
|
":kbd:`F8`", "Toggle :guilabel:`Focus Mode`."
|
||||||
|
":kbd:`F9`", "Re-build the project index."
|
||||||
|
":kbd:`F11`", "Toggle full screen mode."
|
||||||
|
":kbd:`Return`", "If in the project tree, open a document for editing."
|
||||||
":kbd:`Alt`:kbd:`1`", "Switch focus to the project tree. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`1`."
|
":kbd:`Alt`:kbd:`1`", "Switch focus to the project tree. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`1`."
|
||||||
":kbd:`Alt`:kbd:`2`", "Switch focus to document editor. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`2`."
|
":kbd:`Alt`:kbd:`2`", "Switch focus to document editor. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`2`."
|
||||||
":kbd:`Alt`:kbd:`3`", "Switch focus to document viewer. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`3`."
|
":kbd:`Alt`:kbd:`3`", "Switch focus to document viewer. On Windows, use :kbd:`Ctrl`:kbd:`Alt`:kbd:`3`."
|
||||||
@@ -44,14 +55,14 @@ The main shorcuts are as follows:
|
|||||||
":kbd:`Ctrl`:kbd:`D`", "Strikethrough selected text, or word under cursor."
|
":kbd:`Ctrl`:kbd:`D`", "Strikethrough selected text, or word under cursor."
|
||||||
":kbd:`Ctrl`:kbd:`F`", "Open the search bar and search for the selected word, if any is selected."
|
":kbd:`Ctrl`:kbd:`F`", "Open the search bar and search for the selected word, if any is selected."
|
||||||
":kbd:`Ctrl`:kbd:`G`", "Find next occurrence of search word in current document."
|
":kbd:`Ctrl`:kbd:`G`", "Find next occurrence of search word in current document."
|
||||||
":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:`H`", "Open the search and replace tool and search for the selected word, if any is selected. (On Mac, this is :kbd:`Cmd`:kbd:`=`.)"
|
||||||
":kbd:`Ctrl`:kbd:`I`", "Format selected text, or word under cursor, with emphasis (italic)."
|
":kbd:`Ctrl`:kbd:`I`", "Format selected text, or word under cursor, with emphasis (italic)."
|
||||||
":kbd:`Ctrl`:kbd:`K`", "Activate the insert commands. The commands are listed in :ref:`a_kb_ins`."
|
":kbd:`Ctrl`:kbd:`K`", "Activate the insert commands. The commands are listed in :ref:`a_kb_ins`."
|
||||||
":kbd:`Ctrl`:kbd:`L`", "Open the :guilabel:`Quick Links` menu in the Project Tree."
|
":kbd:`Ctrl`:kbd:`L`", "Open the :guilabel:`Quick Links` menu in the Project Tree."
|
||||||
":kbd:`Ctrl`:kbd:`N`", "Create new project item."
|
":kbd:`Ctrl`:kbd:`N`", "Open the Create New Item menu in the Project Tree."
|
||||||
":kbd:`Ctrl`:kbd:`O`", "Open selected document."
|
":kbd:`Ctrl`:kbd:`O`", "Open selected document."
|
||||||
":kbd:`Ctrl`:kbd:`Q`", "Exit novelWriter."
|
":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:`R`", "If in the project tree, open a document for viewing. If in the editor, open current document for viewing."
|
||||||
":kbd:`Ctrl`:kbd:`S`", "Save the current document in the document editor."
|
":kbd:`Ctrl`:kbd:`S`", "Save the current document in the document editor."
|
||||||
":kbd:`Ctrl`:kbd:`V`", "Paste text from clipboard to cursor position."
|
":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:`W`", "Close the current document in the document editor."
|
||||||
@@ -65,7 +76,7 @@ The main shorcuts are as follows:
|
|||||||
":kbd:`Ctrl`:kbd:`Backspace`", "Delete previous 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 single quotes."
|
||||||
":kbd:`Ctrl`:kbd:`""`", "Wrap selected text, or word under cursor, in double 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:`Return`", "Open the tag or reference under the cursor in the Viewer."
|
||||||
":kbd:`Ctrl`:kbd:`Shift`:kbd:`,`", "Open the :guilabel:`Project Settings` dialog."
|
":kbd:`Ctrl`:kbd:`Shift`:kbd:`,`", "Open the :guilabel:`Project Settings` dialog."
|
||||||
":kbd:`Ctrl`:kbd:`Shift`:kbd:`/`", "Remove block formatting for block under cursor."
|
":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:`1`", "Replace occurrence of search word in current document, and search for next occurrence."
|
||||||
@@ -77,20 +88,10 @@ The main shorcuts are as follows:
|
|||||||
":kbd:`Ctrl`:kbd:`Shift`:kbd:`S`", "Save the current project."
|
":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:`W`", "Close the current project."
|
||||||
":kbd:`Ctrl`:kbd:`Shift`:kbd:`Z`", "Undo move of project tree item."
|
":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:`Ctrl`:kbd:`Shift`:kbd:`Del`", "If in the project tree, move an item to Trash."
|
||||||
":kbd:`F1`", "Open the online user manual."
|
|
||||||
":kbd:`F2`", "If in the project tree, edit a document or folder settings."
|
|
||||||
":kbd:`F3`", "Find next occurrence of search word in current document."
|
|
||||||
":kbd:`F5`", "Open the :guilabel:`Build Novel Project` dialog."
|
|
||||||
":kbd:`F6`", "Open the :guilabel:`Writing Statistics` dialog."
|
|
||||||
":kbd:`F7`", "Re-run spell checker."
|
|
||||||
":kbd:`F8`", "Activate :guilabel:`Focus Mode`, hiding the project tree and document viewer."
|
|
||||||
":kbd:`F9`", "Re-build the project index."
|
|
||||||
":kbd:`F11`", "Activate full screen mode."
|
|
||||||
":kbd:`Shift`:kbd:`F1`", "Open the local user manual (PDF) if it is available."
|
":kbd:`Shift`:kbd:`F1`", "Open the local user manual (PDF) if it is available."
|
||||||
":kbd:`Shift`:kbd:`F3`", "Find previous occurrence of search word in current document."
|
":kbd:`Shift`:kbd:`F3`", "Find previous occurrence of search word in current document."
|
||||||
":kbd:`Shift`:kbd:`F6`", "Open the :guilabel:`Project Details` dialog."
|
":kbd:`Shift`:kbd:`F6`", "Open the :guilabel:`Project Details` dialog."
|
||||||
":kbd:`Return`", "If in the project tree, open a document for editing."
|
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
On macOS, replace :kbd:`Ctrl` with :kbd:`Cmd`.
|
On macOS, replace :kbd:`Ctrl` with :kbd:`Cmd`.
|
||||||
|
|||||||
@@ -4,6 +4,11 @@
|
|||||||
Typographical Notes
|
Typographical Notes
|
||||||
*******************
|
*******************
|
||||||
|
|
||||||
|
.. _Prime: https://en.wikipedia.org/wiki/Prime_(symbol)
|
||||||
|
.. _thin space: https://en.wikipedia.org/wiki/Thin_space
|
||||||
|
.. _Quotation Mark: https://en.wikipedia.org/wiki/Quotation_mark
|
||||||
|
.. _Modifier letter apostrophe: https://en.wikipedia.org/wiki/Modifier_letter_apostrophe
|
||||||
|
|
||||||
novelWriter has some support for typographical symbols that are not usually easily available in
|
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,
|
many text editors. This includes for instance the proper unicode quotation marks, dashes, ellipsis,
|
||||||
thin spaces, etc. All these symbols are available from the :guilabel:`Insert` menu, and via
|
thin spaces, etc. All these symbols are available from the :guilabel:`Insert` menu, and via
|
||||||
@@ -17,7 +22,7 @@ This chapter provides some additional information on how novelWriter handles the
|
|||||||
Special Notes on Symbols
|
Special Notes on Symbols
|
||||||
========================
|
========================
|
||||||
|
|
||||||
Some additional notes on the available symbols.
|
This section contains additional notes on the available special symbols.
|
||||||
|
|
||||||
|
|
||||||
Dashes and Ellipsis
|
Dashes and Ellipsis
|
||||||
@@ -49,8 +54,6 @@ user-selected double quote symbols. This is to help the writer recognise which p
|
|||||||
are not using the chosen quote symbols. Two convenience functions in the :guilabel:`Format` menu
|
are not using the chosen quote symbols. Two convenience functions in the :guilabel:`Format` menu
|
||||||
can be used to re-format a selected section of text with the correct quote symbols.
|
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
|
Single and Double Prime
|
||||||
------------------------
|
------------------------
|
||||||
@@ -62,8 +65,6 @@ and double straight quotes, and may be renderred similarly by the font, but they
|
|||||||
codes. Using these correctly will also prevent the auto-replace and dialogue highlighting features
|
codes. Using these correctly will also prevent the auto-replace and dialogue highlighting features
|
||||||
misunderstanding their meaning in the text.
|
misunderstanding their meaning in the text.
|
||||||
|
|
||||||
.. _Prime: https://en.wikipedia.org/wiki/Prime_(symbol)
|
|
||||||
|
|
||||||
|
|
||||||
Modifier Letter Apostrophe
|
Modifier Letter Apostrophe
|
||||||
--------------------------
|
--------------------------
|
||||||
@@ -82,8 +83,6 @@ right single quotation marks, depending on the font. There is a Wikipedia articl
|
|||||||
automatically with the corresponding right hand single quote symbol as is generally recommended.
|
automatically with the corresponding right hand single quote symbol as is generally recommended.
|
||||||
Therefore it doesn't really matter if you only use them to correct highlighting.
|
Therefore it doesn't really matter if you only use them to correct highlighting.
|
||||||
|
|
||||||
.. _Modifier letter apostrophe: https://en.wikipedia.org/wiki/Modifier_letter_apostrophe
|
|
||||||
|
|
||||||
|
|
||||||
Special Space Symbols
|
Special Space Symbols
|
||||||
---------------------
|
---------------------
|
||||||
@@ -100,5 +99,3 @@ 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
|
The thin and non-breaking spaces are converted to their corresponding HTML codes on export to HTML
|
||||||
format.
|
format.
|
||||||
|
|
||||||
.. _thin space: https://en.wikipedia.org/wiki/Thin_space
|
|
||||||
|
|||||||
Reference in New Issue
Block a user