Clean up the remaining sections
This commit is contained in:
Veronica Berglyd Olsen
@@ -5,7 +5,7 @@ Word and Text Counts
|
||||
********************
|
||||
|
||||
This is an overview of how words and other counts of your text are performed. The counting rules
|
||||
should be relatively standard, and are compared to Libre Office Writer rules.
|
||||
should be relatively standard, and are comparable to Libre Office Writer rules.
|
||||
|
||||
The counts provided in the app on the raw text are meant to be approximate. For more accurate
|
||||
counts, you need to build your manuscript in the **Manuscript Tool** and check the counts on the
|
||||
|
||||
@@ -19,6 +19,7 @@ Spell Check Dictionaries
|
||||
novelWriter uses Enchant_ as the spell checking tool. Depending on your operating system, it may or
|
||||
may not load all installed spell check dictionaries automatically.
|
||||
|
||||
|
||||
Linux and MacOS
|
||||
---------------
|
||||
|
||||
@@ -26,6 +27,7 @@ On Linux and MacOS, you generally only have to install hunspell, aspell or myspe
|
||||
your system like you do for other applications. See your distro or OS documentation for how to do
|
||||
this. These dictionaries should show up as available spell check languages in novelWriter.
|
||||
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
@@ -91,10 +93,10 @@ folders are created the first time you start novelWriter.
|
||||
Once the files are copied there, they should show up in **Preferences** with the label you
|
||||
set as ``name`` inside the file.
|
||||
|
||||
.. versionadded:: 2.0
|
||||
The ``icontheme`` value was added to GUI themes. Make sure you set this value in existing custom
|
||||
themes. Otherwise, novelWriter will try to guess your icon theme, and may not pick the most
|
||||
suitable one.
|
||||
.. note::
|
||||
|
||||
The theme file formats change regularly in new releases. It is up to you to keep custom theme
|
||||
files up to date.
|
||||
|
||||
|
||||
Custom GUI and Icons Theme
|
||||
@@ -112,7 +114,26 @@ A GUI theme ``.conf`` file consists of the following settings:
|
||||
url = https://example.com
|
||||
license = CC BY-SA 4.0
|
||||
licenseurl = https://creativecommons.org/licenses/by-sa/4.0/
|
||||
icontheme = typicons_light
|
||||
|
||||
[Icons]
|
||||
default = 100, 100, 100
|
||||
faded = 100, 100, 100
|
||||
red = 255, 0, 0
|
||||
orange = 255, 128, 0
|
||||
yellow = 255, 255, 0
|
||||
green = 0, 255, 0
|
||||
aqua = 0, 255, 255
|
||||
blue = 0, 0, 255
|
||||
purple = 255, 0, 255
|
||||
|
||||
[Project]
|
||||
root = 0, 255, 255
|
||||
folder = 255, 255, 0
|
||||
file = 100, 100, 100
|
||||
title = 0, 255, 0
|
||||
chapter = 255, 0, 0
|
||||
scene = 0, 0, 255
|
||||
note = 255, 255, 0
|
||||
|
||||
[Palette]
|
||||
window = 100, 100, 100
|
||||
@@ -134,24 +155,23 @@ A GUI theme ``.conf`` file consists of the following settings:
|
||||
helptext = 0, 0, 0
|
||||
fadedtext = 128, 128, 128
|
||||
errortext = 255, 0, 0
|
||||
statusnone = 120, 120, 120
|
||||
statussaved = 2, 133, 37
|
||||
statusunsaved = 200, 15, 39
|
||||
|
||||
In the Main section you must at least define the ``name`` and ``icontheme`` settings. The
|
||||
``icontheme`` settings should correspond to one of the internal icon themes, either
|
||||
``typicons_light`` or ``typicons_dark``, or to an icon theme in your custom icons directory. The
|
||||
setting must match the icon theme's folder name.
|
||||
In the Main section you must at least define the ``name`` settings.
|
||||
|
||||
The Palette values correspond to the Qt enum values for ``QPalette::ColorRole``, see the
|
||||
`Qt documentation <https://doc.qt.io/qt-6/qpalette.html#ColorRole-enum>`_ for more details. The
|
||||
colour values are RGB numbers on the format ``r, g, b`` where each is an integer from ``0`` to
|
||||
``255``. Omitted values are not loaded and will use default values. If the ``helptext`` colour is
|
||||
not defined, it is computed as a colour between the ``window`` and ``windowtext`` colour.
|
||||
Additional shades of some of the colours are also computed. These are mainly used for 3D effects.
|
||||
|
||||
.. versionadded:: 2.5
|
||||
The ``fadedtext`` and ``errortext`` theme colour entries were added.
|
||||
|
||||
.. versionadded:: 2.7
|
||||
The ``icontheme`` setting was dropped as the icon theme is now its own setting.
|
||||
The ``[Icons]`` and ``[Project]`` sections were added, and the ``status*`` settings removed.
|
||||
|
||||
|
||||
Custom Syntax Theme
|
||||
-------------------
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
Handling Errors
|
||||
***************
|
||||
|
||||
In case something goes wrong, novelWriter has a few built-in features to reduce the change your
|
||||
In case something goes wrong, novelWriter has a few built-in features to reduce the chance your
|
||||
work is lost. In case of a crash, it will also try to save whatever changes you have made before
|
||||
existing, if this is at all possible.
|
||||
exiting, if this is at all possible.
|
||||
|
||||
The storage solution is designed to save each text document independently, so only the document
|
||||
you're working on is actually at a risk of losing data in the event of a crash.
|
||||
@@ -42,7 +42,7 @@ Project Lockfile
|
||||
|
||||
To prevent data loss caused by file conflicts when novelWriter projects are synchronised via file
|
||||
synchronisation tools, a project lockfile is written to the project storage folder when a project
|
||||
is open. If you try to open a project which already has such a file present, you will be presented
|
||||
is open. If you try to open a project that already has such a file present, you will be presented
|
||||
with a warning, and some information about where else novelWriter thinks the project is also open.
|
||||
You will be given the option to ignore this warning, and continue opening the project at your own
|
||||
risk.
|
||||
|
||||
@@ -4,9 +4,6 @@
|
||||
Project Format Changes
|
||||
**********************
|
||||
|
||||
.. _File Format Spec 1.5: _static/fileformatspec15.pdf
|
||||
.. _documentation: https://docs.novelwriter.io/
|
||||
|
||||
Most of the changes to the file formats over the history of novelWriter have no impact on the
|
||||
user side of things. The project files are generally updated automatically. However, some of the
|
||||
changes require minor actions from the user.
|
||||
@@ -17,6 +14,7 @@ where applicable.
|
||||
A full project file format specification is available under "More Documents".
|
||||
|
||||
.. caution::
|
||||
|
||||
When you update a project from one format version to the next, the project can no longer be
|
||||
opened by a version of novelWriter prior to the version where the new file format was
|
||||
introduced. You will get a notification about any updates to your project file format and will
|
||||
@@ -87,7 +85,7 @@ should be used only a few places in any given project. These are as follows:
|
||||
|
||||
* The layout named "Plain Page" has also been removed. The only feature of this layout was that it
|
||||
ensured that the content always started on a fresh page. In the new format, fresh pages can be
|
||||
set anywhere in the text with the ``[NEW PAGE]`` code. See :ref:`docs_usage_formatting_breaks`.
|
||||
set anywhere in the text with the ``[new page]`` code. See :ref:`docs_usage_formatting_breaks`.
|
||||
|
||||
|
||||
.. _docs_more_project_formats_1_2:
|
||||
@@ -98,6 +96,7 @@ Format 1.2 Changes
|
||||
This project format was introduced in novelWriter version 0.10.
|
||||
|
||||
With this format, the way auto-replace entries were stored in the main project XML file changed.
|
||||
Conversion from this format is done automatically.
|
||||
|
||||
|
||||
.. _docs_more_project_formats_1_1:
|
||||
@@ -111,7 +110,8 @@ With this format, the ``content`` folder was introduced in the project storage.
|
||||
novelWriter documents were saved in a series of folders numbered from ``data_0`` to ``data_f``.
|
||||
|
||||
It also reduces the number of meta data and cache files. These files are automatically deleted if
|
||||
an old project is opened. This was also when the Table of Contents file was introduced.
|
||||
an old project is opened. This was also when the Table of Contents file was introduced. Conversion
|
||||
from this format is done automatically.
|
||||
|
||||
|
||||
.. _docs_more_project_formats_1_0:
|
||||
|
||||
@@ -17,21 +17,17 @@ keyboard shortcuts. See :ref:`docs_features_shortcuts_insert`.
|
||||
This chapter provides some additional information on how novelWriter handles these symbols.
|
||||
|
||||
|
||||
.. _docs_more_typographical_symbols:
|
||||
|
||||
Special Notes on Symbols
|
||||
========================
|
||||
|
||||
This section contains additional notes on the available special symbols.
|
||||
|
||||
|
||||
Dashes and Ellipsis
|
||||
-------------------
|
||||
===================
|
||||
|
||||
With the auto-replace feature enabled (see :ref:`docs_ui_edit_view_auto`), multiple hyphens are
|
||||
converted automatically to short and long dashes, and three dots to ellipsis. The last auto-replace
|
||||
can always be reverted with the undo command :kbd:`Ctrl+Z`, reverting the text to what you typed
|
||||
before the automatic replacement occurred.
|
||||
With the auto-replace feature enabled (see :ref:`docs_ui_edit_view_auto`), two and three hyphens
|
||||
are converted automatically to short and long dashes, four hyphens to a horizontal bar, and three
|
||||
dots to ellipsis.
|
||||
|
||||
.. tip::
|
||||
|
||||
The last auto-replace can always be reverted with the undo command :kbd:`Ctrl+Z`, reverting the
|
||||
text to what you typed before the automatic replacement occurred.
|
||||
|
||||
In addition, "Figure Dash" is available. The Figure Dash is a dash that has the same width as the
|
||||
numbers of the same font, for most fonts. It helps to align numbers nicely in columns when you need
|
||||
@@ -39,24 +35,22 @@ to use a dash in them.
|
||||
|
||||
|
||||
Single and Double Quotes
|
||||
------------------------
|
||||
========================
|
||||
|
||||
All the different quotation marks listed on the `Quotation Mark`_ Wikipedia page are available, and
|
||||
can be selected as auto-replaced symbols for straight single and double quote key strokes. The
|
||||
settings can be found in **Preferences**.
|
||||
|
||||
Ordinarily, text wrapped in quotes are highlighted by the editor. This is meant as a convenience
|
||||
for highlighting dialogue between characters. This feature can be disabled in
|
||||
**Preferences** if this feature isn't wanted.
|
||||
If your text contains straight single and double quotes, there are two convenience functions in the
|
||||
**Format** menu that can be used to re-format a selected section of text with the correct quote
|
||||
symbols.
|
||||
|
||||
The editor distinguishes between text wrapped in regular straight double quotes and the
|
||||
user-selected double quote symbols. This is to help the writer recognise which parts of the text
|
||||
are not using the chosen quote symbols. Two convenience functions in the **Format** menu
|
||||
can be used to re-format a selected section of text with the correct quote symbols.
|
||||
You can enable dialogue recognition and colour highlighting for novel documents.
|
||||
See :ref:`docs_features_dialogue` for more details.
|
||||
|
||||
|
||||
Single and Double Prime
|
||||
------------------------
|
||||
=======================
|
||||
|
||||
Both single and double prime symbols are available in the **Insert** menu. These symbols
|
||||
are the correct symbols to use for unit symbols for feet, inches, minutes, and seconds. The usage
|
||||
@@ -69,7 +63,7 @@ misunderstanding their meaning in the text.
|
||||
.. _docs_more_typographical_symbols_apostrophe:
|
||||
|
||||
Modifier Letter Apostrophe
|
||||
--------------------------
|
||||
==========================
|
||||
|
||||
The auto-replace feature will consider any right-facing single straight quote as a quote symbol,
|
||||
even if it is intended as an apostrophe. This also includes the syntax highlighter, which may
|
||||
@@ -81,13 +75,15 @@ right single quotation marks, depending on the font. There is a Wikipedia articl
|
||||
`Modifier letter apostrophe`_ with more details.
|
||||
|
||||
.. note::
|
||||
|
||||
On export with the **Build Manuscript** tool, these apostrophes will be replaced
|
||||
automatically with the corresponding right hand single quote symbol as is generally recommended.
|
||||
Therefore it doesn't really matter if you only use them to correct syntax highlighting.
|
||||
Therefore it doesn't really matter if you only use them to correct syntax highlighting in some
|
||||
places, and not others.
|
||||
|
||||
|
||||
Special Space Symbols
|
||||
---------------------
|
||||
White Space Symbols
|
||||
===================
|
||||
|
||||
A few variations of the regular space character is supported. The correct typographical way to
|
||||
separate a number from its unit is with a `thin space`_. It is usually 2/3 the width of a regular
|
||||
@@ -99,5 +95,11 @@ A regular space can also be made into a non-breaking space if needed.
|
||||
All non-breaking spaces are highlighted with a differently coloured background to make it easier to
|
||||
spot them in the text. The colour will depend on the selected colour theme.
|
||||
|
||||
The thin and non-breaking spaces are converted to their corresponding HTML codes on export to HTML
|
||||
format.
|
||||
You can insert these spaces in your text using the following keyboard combinations:
|
||||
|
||||
* A non-breaking space can be inserted with :kbd:`Ctrl+K`, :kbd:`Space`.
|
||||
* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl+K`, :kbd:`Shift+Space`.
|
||||
* Non-breaking thin space can be inserted with :kbd:`Ctrl+K`, :kbd:`Ctrl+Space`.
|
||||
|
||||
These are all insert features, and the **Insert** menu has more. The keyboard shortcuts for them
|
||||
are also listed in :ref:`docs_features_shortcuts`.
|
||||
|
||||
Reference in New Issue
Block a user