Update the remaining docs
This commit is contained in:
@@ -18,7 +18,7 @@ storage for robustness.
|
|||||||
|
|
||||||
The project storage is suitable for version control software, and also well suited for file
|
The project storage is suitable for version control software, and also well suited for file
|
||||||
synchronisation tools. All text is saved as plain text files, and your project data as standard
|
synchronisation tools. All text is saved as plain text files, and your project data as standard
|
||||||
data formats in XML and JSON. See :ref:`a_tech_overview` for more details.
|
data formats in XML and JSON. See :ref:`a_storage` for more details.
|
||||||
|
|
||||||
Any operating system that has Python 3 and the Qt 5 libraries should be able to run novelWriter.
|
Any operating system that has Python 3 and 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 as well.
|
It runs fine on Linux, Windows and MacOS, and users have tested it on other platforms as well.
|
||||||
@@ -89,7 +89,6 @@ See :ref:`a_started` for more details.
|
|||||||
:caption: Technical Topics
|
:caption: Technical Topics
|
||||||
:hidden:
|
:hidden:
|
||||||
|
|
||||||
tech_overview
|
|
||||||
tech_locations
|
tech_locations
|
||||||
tech_storage
|
tech_storage
|
||||||
tech_source
|
tech_source
|
||||||
|
|||||||
@@ -8,8 +8,8 @@ This is an overview of how words and other counts of your text are performed. Th
|
|||||||
should be relatively standard, and are compared to Libre Office Writer rules.
|
should be relatively standard, and are compared to Libre Office Writer rules.
|
||||||
|
|
||||||
The counts provided in the app on the raw text is meant to be approximate. For more accurate
|
The counts provided in the app on the raw text is meant to be approximate. For more accurate
|
||||||
counts, you need to build your manuscript in the :guilabel:`Manuscript Tool` and check the counts
|
counts, you need to build your manuscript in the **Manuscript Tool** and check the counts on the
|
||||||
on the generated preview.
|
generated preview.
|
||||||
|
|
||||||
|
|
||||||
Text Word Counts and Stats
|
Text Word Counts and Stats
|
||||||
@@ -31,11 +31,11 @@ After the above preparation of the text, the following counts are available.
|
|||||||
**Character Count**
|
**Character Count**
|
||||||
The character count is the sum of characters per line, including leading and in-text white space
|
The character count is the sum of characters per line, including leading and in-text white space
|
||||||
characters, but excluding trailing white space characters. Shortcodes in the text are not
|
characters, but excluding trailing white space characters. Shortcodes in the text are not
|
||||||
included, but Markdown codes are. Only headers and text are counted.
|
included, but Markdown codes are. Only headings and text are counted.
|
||||||
|
|
||||||
**Word Count**
|
**Word Count**
|
||||||
The words count is the sum of blocks of continuous character per line separated by any number of
|
The words count is the sum of blocks of continuous character per line separated by any number of
|
||||||
white space characters or dashes. Only headers and text are counted.
|
white space characters or dashes. Only headings and text are counted.
|
||||||
|
|
||||||
**Paragraph Count**
|
**Paragraph Count**
|
||||||
The paragraph count is the number of text blocks separated by one or more empty line. A line
|
The paragraph count is the number of text blocks separated by one or more empty line. A line
|
||||||
@@ -45,10 +45,10 @@ After the above preparation of the text, the following counts are available.
|
|||||||
Manuscript Counts
|
Manuscript Counts
|
||||||
=================
|
=================
|
||||||
|
|
||||||
These are the rules for the counts available for a manuscript in the :guilabel:`Manuscript Tool`.
|
These are the rules for the counts available for a manuscript in the **Manuscript Tool**. The rules
|
||||||
The rules have been tuned to agree with LibreOffice Writer, but will vary slightly depending on the
|
have been tuned to agree with LibreOffice Writer, but will vary slightly depending on the content
|
||||||
content of your text. LibreOffice Writer also counts the text in the page header, which the
|
of your text. LibreOffice Writer also counts the text in the page header, which the **Manuscript
|
||||||
Manuscript Tool does not.
|
Tool** does not.
|
||||||
|
|
||||||
The content of each line is counted after all formatting has been processed, so the result will be
|
The content of each line is counted after all formatting has been processed, so the result will be
|
||||||
more accurate than the counts for text documents elsewhere in the app. The following rules apply:
|
more accurate than the counts for text documents elsewhere in the app. The following rules apply:
|
||||||
@@ -63,36 +63,36 @@ more accurate than the counts for text documents elsewhere in the app. The follo
|
|||||||
|
|
||||||
The following counts are available:
|
The following counts are available:
|
||||||
|
|
||||||
**Header Count**
|
**Headings**
|
||||||
The number of headers in the manuscript.
|
The number of headings in the manuscript.
|
||||||
|
|
||||||
**Paragraph Count**
|
**Paragraphs**
|
||||||
The number of body text paragraphs in the manuscript.
|
The number of body text paragraphs in the manuscript.
|
||||||
|
|
||||||
**Total Word Count**
|
**Words**
|
||||||
The number of words in the manuscript, including any comments and meta data text.
|
The number of words in the manuscript, including any comments and meta data text.
|
||||||
|
|
||||||
**Text Word Count**
|
**Words in Text**
|
||||||
The number of words in body text paragraphs, excluding all other text.
|
The number of words in body text paragraphs, excluding all other text.
|
||||||
|
|
||||||
**Header Word Count**
|
**Words in Headings**
|
||||||
The number of words in headers, including inserted formatting like chapter numbers, etc.
|
The number of words in headings, including inserted formatting like chapter numbers, etc.
|
||||||
|
|
||||||
**Total Character Count**
|
**Characters**
|
||||||
The number of characters on all lines, including any comments and meta data text. Paragraph
|
The number of characters in all lines, including any comments and meta data text. Paragraph
|
||||||
breaks are not counted, but in-paragraph hard line breaks are.
|
breaks are not counted, but in-paragraph hard line breaks are.
|
||||||
|
|
||||||
**Text Character Count**
|
**Character in Text**
|
||||||
The number of characters in body text paragraphs. Paragraph breaks are not counted, but
|
The number of characters in body text paragraphs. Paragraph breaks are not counted, but
|
||||||
in-paragraph hard line breaks are.
|
in-paragraph hard line breaks are.
|
||||||
|
|
||||||
**Header Character Count**
|
**Characters in Headings**
|
||||||
The number of characters in headings.
|
The number of characters in headings.
|
||||||
|
|
||||||
**Text Words Character Count**
|
**Character in Text, No Spaces**
|
||||||
The number of characters in body text paragraphs considered part of a word or punctuation. That
|
The number of characters in body text paragraphs considered part of a word or punctuation. That
|
||||||
is, white space characters are not counted.
|
is, white space characters are not counted.
|
||||||
|
|
||||||
**Header Words Character Count**
|
**Character in Headings, No Spaces**
|
||||||
The number of characters in headers considered part of a word or punctuation. That is, white
|
The number of characters in headings considered part of a word or punctuation. That is, white
|
||||||
space characters are not counted.
|
space characters are not counted.
|
||||||
|
|||||||
@@ -34,10 +34,10 @@ and add dictionaries yourself.
|
|||||||
|
|
||||||
**Install Tool**
|
**Install Tool**
|
||||||
|
|
||||||
A small tool to assist with this can be found under :guilabel:`Tools > Add Dictionaries`. It will
|
A small tool to assist with this can be found under **Tools > Add Dictionaries**. It will import
|
||||||
import spell checking dictionaries from Free Office or Libre Office extensions. The dictionaries
|
spell checking dictionaries from Free Office or Libre Office extensions. The dictionaries are then
|
||||||
are then installed in the install location for the Enchant library and should thus work for any
|
installed in the install location for the Enchant library and should thus work for any application
|
||||||
application that uses Enchant for spell checking.
|
that uses Enchant for spell checking.
|
||||||
|
|
||||||
**Manual Install**
|
**Manual Install**
|
||||||
|
|
||||||
@@ -81,14 +81,14 @@ modify it as you like.
|
|||||||
`novelwriter/assets/icons <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/icons>`_.
|
`novelwriter/assets/icons <https://github.com/vkbo/novelWriter/tree/main/novelwriter/assets/icons>`_.
|
||||||
|
|
||||||
Remember to also change the name of your theme by modifying the ``name`` setting at the top of the
|
Remember to also change the name of your theme by modifying the ``name`` setting at the top of the
|
||||||
file, otherwise you may not be able to distinguish them in :guilabel:`Preferences`.
|
file, otherwise you may not be able to distinguish them in **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, just ``themes`` for GUI themes, and ``icons`` for icon themes. These
|
``syntax`` for syntax themes, just ``themes`` for GUI themes, and ``icons`` for icon themes. These
|
||||||
folders are created the first time you start novelWriter.
|
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 **Preferences** with the label you
|
||||||
set as ``name`` inside the file.
|
set as ``name`` inside the file.
|
||||||
|
|
||||||
.. versionadded:: 2.0
|
.. versionadded:: 2.0
|
||||||
@@ -190,10 +190,10 @@ Omitted syntax colours default to black, except ``background`` which defaults to
|
|||||||
``texthighlight`` which defaults to white with half transparency.
|
``texthighlight`` which defaults to white with half transparency.
|
||||||
|
|
||||||
.. versionadded:: 2.2
|
.. versionadded:: 2.2
|
||||||
The `shortcode` syntax colour entry was added.
|
The ``shortcode`` syntax colour entry was added.
|
||||||
|
|
||||||
.. versionadded:: 2.3
|
.. versionadded:: 2.3
|
||||||
The `optional` syntax colour entry was added.
|
The ``optional`` syntax colour entry was added.
|
||||||
|
|
||||||
.. versionadded:: 2.4
|
.. versionadded:: 2.4
|
||||||
The `texthighlight` syntax colour entry was added.
|
The ``texthighlight`` syntax colour entry was added.
|
||||||
|
|||||||
@@ -15,10 +15,9 @@ file locations are described in this chapter.
|
|||||||
Configuration
|
Configuration
|
||||||
=============
|
=============
|
||||||
|
|
||||||
The general configuration of novelWriter, including everything that is in :guilabel:`Preferences`,
|
The general configuration of novelWriter, including everything that is in **Preferences**, is saved
|
||||||
is saved in one central configuration file. The location of this file depends on your operating
|
in one central configuration file. The location of this file depends on your operating system. The
|
||||||
system. The system paths are provided by the Qt QStandardPaths_ class and its ``ConfigLocation``
|
system paths are provided by the Qt QStandardPaths_ class and its ``ConfigLocation`` value.
|
||||||
value.
|
|
||||||
|
|
||||||
The standard paths are:
|
The standard paths are:
|
||||||
|
|
||||||
@@ -40,9 +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 should also be
|
list of recent projects form the **Welcome** dialog. Custom themes should also be saved here. The
|
||||||
saved here. The system paths are provided by the Qt QStandardPaths_ class and its
|
system paths are provided by the Qt QStandardPaths_ class and its ``AppDataLocation`` value.
|
||||||
``AppDataLocation`` value.
|
|
||||||
|
|
||||||
The standard paths are:
|
The standard paths are:
|
||||||
|
|
||||||
@@ -56,3 +54,12 @@ user's username on Windows.
|
|||||||
.. note::
|
.. note::
|
||||||
These are the standard operating system defined locations. If your system has been set up in a
|
These are the standard operating system defined locations. If your system has been set up in a
|
||||||
different way, these locations may also be different.
|
different way, these locations may also be different.
|
||||||
|
|
||||||
|
The Application Data location also holds several folders:
|
||||||
|
|
||||||
|
``cache``
|
||||||
|
This folder is used to save the preview data for the **Manuscript Build** tool.
|
||||||
|
|
||||||
|
``icons``, ``syntax`` and ``themes``
|
||||||
|
These folders are empty by default, but this is where the user can store custom theme files.
|
||||||
|
See :ref:`a_custom` for more details.
|
||||||
|
|||||||
@@ -1,20 +0,0 @@
|
|||||||
.. _a_tech_overview:
|
|
||||||
|
|
||||||
******************
|
|
||||||
Technical Overview
|
|
||||||
******************
|
|
||||||
|
|
||||||
|
|
||||||
novelWriter is built as a cross-platform application using `Python 3 <https://www.python.org/>`_ as
|
|
||||||
the programming language, and `Qt 5 <https://www.qt.io/>`_ framework for the user interface.
|
|
||||||
|
|
||||||
novelWriter is built for Linux first, so this is where it works best. However, it also runs fine
|
|
||||||
on Windows and MacOS due to the cross-platform framework it's built on. The author of the
|
|
||||||
application doesn't own a Mac, so on-going Mac support is dependent on user feedback and user
|
|
||||||
contributions.
|
|
||||||
|
|
||||||
Spell checking in novelWriter is provided by a third party library called
|
|
||||||
`Enchant <https://abiword.github.io/enchant/>`_. Please see the section on :ref:`a_custom_dict` for
|
|
||||||
how to install spell checking languages.
|
|
||||||
|
|
||||||
For install instructions for novelWriter, see :ref:`a_started`.
|
|
||||||
@@ -159,6 +159,5 @@ You can also build a PDF manual from the documentation using the ``pkgutils.py``
|
|||||||
python pkgutils.py manual
|
python pkgutils.py manual
|
||||||
|
|
||||||
This will build the documentation as a PDF using LaTeX. The file will then be copied into the
|
This will build the documentation as a PDF using LaTeX. The file will then be copied into the
|
||||||
assets folder and made available in the :guilabel:`Help` menu in novelWriter. The Sphinx build
|
assets folder and made available in the **Help** menu in novelWriter. The Sphinx build system has a
|
||||||
system has a few extra dependencies when building the PDF. Please check the `Sphinx Docs`_ for more
|
few extra dependencies when building the PDF. Please check the `Sphinx Docs`_ for more details.
|
||||||
details.
|
|
||||||
|
|||||||
@@ -55,10 +55,10 @@ string. The documents are saved with a filename assembled from this handle and t
|
|||||||
``.nwd``.
|
``.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 **Show File Details** from the **Document** menu when having the
|
||||||
when having the document open in the editor, or look in the ``ToC.txt`` file in the root of the
|
document open in the editor, or look in the ``ToC.txt`` file in the root of the project folder. The
|
||||||
project folder. The ``ToC.txt`` file has a list of all documents in the project, referenced by
|
``ToC.txt`` file has a list of all documents in the project, referenced by their label, and where
|
||||||
their label, and where they are saved.
|
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
|
||||||
@@ -109,7 +109,7 @@ The Project Index
|
|||||||
|
|
||||||
Between writing sessions, the project index is saved in a JSON file in ``meta/index.json``.
|
Between writing sessions, the project index is saved in a JSON file in ``meta/index.json``.
|
||||||
This file is not critical. If it is lost, it can be completely rebuilt from within novelWriter from
|
This file is not critical. If it is lost, it can be completely rebuilt from within novelWriter from
|
||||||
the :guilabel:`Tools` menu.
|
the **Tools** menu.
|
||||||
|
|
||||||
The index is maintained and updated whenever a document or note is saved in the editor. It contains
|
The index is maintained and updated whenever a document or note is saved in the editor. It contains
|
||||||
all references and tags in documents and notes, as well as the location of all headers in the
|
all references and tags in documents and notes, as well as the location of all headers in the
|
||||||
@@ -125,8 +125,8 @@ the index. If this too fails, you have likely encountered a bug.
|
|||||||
Build Definitions
|
Build Definitions
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
The build definitions from the :guilabel:`Manuscript Build` tool are kept in the
|
The build definitions from the **Manuscript Build** tool are kept in the ``meta/builds.json`` file.
|
||||||
``meta/builds.json`` file. If this file is lost, all custom build definitions are lost too.
|
If this file is lost, all custom build definitions are lost too.
|
||||||
|
|
||||||
|
|
||||||
Cached GUI Options
|
Cached GUI Options
|
||||||
@@ -144,17 +144,17 @@ Custom Word List
|
|||||||
----------------
|
----------------
|
||||||
|
|
||||||
A file named ``meta/userdict.json`` contains all the custom words you've added to the project for
|
A file named ``meta/userdict.json`` 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
|
spell checking purposes. The content of the file can be edited from the **Tools** menu. If you lose
|
||||||
you lose this file, all your custom spell check words will be lost too.
|
this file, all your custom spell check words will be lost too.
|
||||||
|
|
||||||
|
|
||||||
Session Stats
|
Session Stats
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
The writing progress is saved in the ``meta/sessions.jsonl`` file. This file records the length
|
The writing progress is saved in the ``meta/sessions.jsonl`` file. This file records the length
|
||||||
and word counts of each writing session on the given project. The file is used by the
|
and word counts of each writing session on the given project. The file is used by the **Writing
|
||||||
:guilabel:`Writing Statistics` tool. If this file is lost, the history it contains is also lost,
|
Statistics** tool. If this file is lost, the history it contains is also lost, but it has otherwise
|
||||||
but it has otherwise no impact on the project.
|
no impact on the project.
|
||||||
|
|
||||||
Each session is recorded as a JSON object on a single line of the file. Each session record is
|
Each session is recorded as a JSON object on a single line of the file. Each session record is
|
||||||
appended tot he file.
|
appended tot he file.
|
||||||
|
|||||||
Reference in New Issue
Block a user