Skip to content

Commit

Permalink
Make a second apss through the entire documentation to fix issues
Browse files Browse the repository at this point in the history
  • Loading branch information
vkbo committed Oct 15, 2023
1 parent cceb31a commit ccffa91
Show file tree
Hide file tree
Showing 21 changed files with 278 additions and 269 deletions.
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ storage for robustness.

The project storage is suitable for version control software, and also well suited for file
synchronisation tools. All text is saved as plain text files with a meta data header. The core
project structure is stored in a single project XML file. Other meta data is primarily saved as
JSON files. See the :ref:`a_breakdown_storage` section for more details.
project structure is stored in a single project XML file. Other meta data is saved as 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
novelWriter. It runs fine on Linux, Windows and MacOS, and users have tested it on other platforms
as well. novelWriter can also be run directly from the Python source, or installed from packages or
from pip. See :ref:`a_started` for more details.
with pip. See :ref:`a_started` for more details.

**Useful Links**

Expand Down
19 changes: 8 additions & 11 deletions docs/source/int_customise.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Spell Check Dictionaries
========================

novelWriter uses Enchant_ as the spell checking tool. Depending on your operating system, it may or
may not load installed spell check dictionaries automatically.
may not load all installed spell check dictionaries automatically.

Linux and MacOS
---------------
Expand All @@ -40,7 +40,6 @@ This assumes your user profile is stored at ``C:\Users\<USER>``. The last one or
not exist, so you may need to create them.

.. note::

The Free Desktop link points to a repository, and what may look like file links inside the
dictionary folder are actually links to web pages. If you right-click and download those, you
get HTML files, not dictionaries!
Expand All @@ -54,9 +53,9 @@ not exist, so you may need to create them.
Syntax and GUI Themes
=====================

Adding your own GUI and syntax themes is relatively easy altough requires that you manually edit
config files with colour values. The themes are defined by simple plain text config files with meta
data and colour settings.
Adding your own GUI and syntax themes is relatively easy, altough it requires that you manually
edit config files with colour values. The themes are defined by simple plain text config files with
meta data and colour settings.

In order to make your own versions, first copy one of the existing files to your local computer and
modify it as you like.
Expand All @@ -81,15 +80,14 @@ 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 it defaults to ``typicons_light``, which may not match your theme colour
scheme. Otherwise, novelWriter will try to guess your icon theme, and may not pick the most
themes. Otherwise, novelWriter will try to guess your icon theme, and may not pick the most
suitable one.


Gustom GUI and Icons Theme
--------------------------

A GUI theme conf file consists of the follwing settings:
A GUI theme ``.conf`` file consists of the follwing settings:

.. code-block:: cfg
Expand Down Expand Up @@ -138,7 +136,7 @@ Omitted values are not loaded and will use default values.
Custom Syntax Theme
-------------------

A syntax theme conf file consists of the follwing settings:
A syntax theme ``.conf`` file consists of the follwing settings:

.. code-block:: cfg
Expand Down Expand Up @@ -168,7 +166,6 @@ A syntax theme conf file consists of the follwing settings:
replacetag = 0, 0, 0
modifier = 0, 0, 0
In the Main section, you must define at least the ``name`` setting. The Syntax colour values are
RGB numbers on the format ``r, g, b`` where each is an integer from to 255. Omitted values are set
RGB numbers on the format ``r, g, b`` where each is an integer from to 255. Omitted values default
to black, except ``background`` which defaults to white,
4 changes: 2 additions & 2 deletions docs/source/int_howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Managing the Project
:guilabel:`Merge Documents in Folder`.

In the dialog that pops up, the documents will be in the same order as in the folder, but you
can also rearrange them here of you wish.
can also rearrange them here of you wish. See :ref:`a_ui_tree_split_merge` for more details.


Layout Tricks
Expand Down Expand Up @@ -68,7 +68,7 @@ Organising Your Text
for soft scene breaks. the :guilabel:`Build Manuscript` tool will let you add separate
formatting for the two when you generate your manuscript. You can for instance add the common
"``* * *``" for hard breaks and select to hide section breaks, which will just insert an empty
paragraph in their place.
paragraph in their place. See :ref:`a_manuscript_settings` for more details.


Other Tools
Expand Down
32 changes: 16 additions & 16 deletions docs/source/int_introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Key Features
.. _Snowflake: https://www.advancedfictionwriting.com/articles/snowflake-method/
.. _Markdown: https://en.wikipedia.org/wiki/Markdown

At the core, novelWriter is a multi-document plain text editor. It uses a markup syntax inspired by
At its core, novelWriter is a multi-document plain text editor. It uses a markup syntax inspired by
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, and it is *not* a full feature Markdown editor.
formatting features available are limited to those relevant for this purpose. It is *not* suitable
for technical writing, and it is *not* a full-feature Markdown editor.

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
Expand All @@ -22,8 +22,8 @@ your notes about your characters, your world building, and so on.

You can at any point split the individual documents by their headers up into multiple documents, or
merge multiple documents into single documents. This makes it easier to use variations of the
popular Snowflake_ method for writing. You can focus on writing larger structure-focused documents,
like one per act for instance, and later effortlessly split these up into scenes by their headers.
Snowflake_ method for writing. You can focus on writing larger structure-focused documents, like
one per act for instance, and later effortlessly split these up into scenes by their headers.

Below are some key features of novelWriter.

Expand All @@ -42,11 +42,11 @@ Below are some key features of novelWriter.

**Organise your documents how you like**
You can split your novel project up into as many individual documents as you want to. When you
build the project, they are all glued together in the top-to-bottom order in which they appear
in the project tree. You can use as few text documents as you like, but splitting the project up
into chapters and scenes means you can easily reorder them using the drag and drop feature. You
can start out with a few documents and then later split them into multiple documents based on
their headers.
build the project into a manuscript, they are all glued together in the top-to-bottom order in
which they appear in the project tree. You can use as few text documents as you like, but
splitting the project up into chapters and scenes means you can easily reorder them using the
drag-and-drop feature. You can also start out with a few documents and then later split them
into multiple documents based on their headers.

**Multi-novel project support**
As of novelWriter 2.0, you can have multiple Novel type root folders in a project. This allows
Expand All @@ -56,22 +56,22 @@ Below are some key features of novelWriter.
**Keep track of your plot elements**
All notes in your project can be assigned a :term:`tag` that you can :term:`reference` from any
other document or note. In fact, you can add a new tag under each heading of a note if you need
to be able to reference specific sections.
to be able to reference specific sections of ot.

**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,
scenes, and sections of your project. If they have any references in them, these are listed in
additional columns. You can also add a synopsis to each document, which can be listed here as
well. You have the option to add or remove columns of information from this outline. A subset of
the outline information is also available in the :guilabel:`Novel View` as an alternative view
to the project tree.
additional columns. You can also add a synopsis to each chapter or scene, which can be listed
here as well. You have the option to add or remove columns of information from this outline. A
subset of the outline information is also available in the :guilabel:`Novel View` as an
alternative view to the project tree.

**Building your manuscript**
Whether you want to assemble 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 Manuscript` tool to
do so. 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 can be opened by most office type word processors. You can also generate the result
file that 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.


Expand Down
43 changes: 22 additions & 21 deletions docs/source/int_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@ novelWriter is built as a cross-platform application using `Python 3 <https://ww
the programming language, and `Qt 5 <https://www.qt.io/>`_ for the user interface.

novelWriter is built for Linux first, and this is where it works best. However, it also runs fine
on Windows and MacOS due to being built with cross-platform tools. The author of the application
doesn't own a Mac, so on-going Mac support is dependant on user feedback and user contributions.
on Windows and MacOS due to the cross-platform framework it's build on. The author of the
application doesn't own a Mac, so on-going Mac support is dependant 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 handle spell checking in different languages.
how to install spell checking languages.

For install instructions, see :ref:`a_started`.

Expand All @@ -28,40 +29,40 @@ Using novelWriter
=================

In order to use novelWriter effectively, you need to know the basics of how it works. The following
sections will explain the main principles. It starts with the basics, and gets more detailed as you
chapters will explain the main principles. It starts with the basics, and gets more detailed as you
read on.

:ref:`a_breakdown` – Essential Information
This section explains the basics of how the application works and what it can and cannot do.
This chapter explains the basics of how the application works and what it can and cannot do.

:ref:`a_ui_project` – Recommended Reading
This section will give you a more detailed explanation of how you the user interface components
This chapter will give you a more detailed explanation of how you the user interface components
to organise and view your project work.

:ref:`a_ui_writing` – Recommended Reading
This section will give you a more detailed explanation of how the text editor and viewer work.
This chapter will give you a more detailed explanation of how the text editor and viewer work.

:ref:`a_fmt` – Essential Information
This section covers how you should format your text. The editor is plain text, so text
This chapter 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
use headings. Tags and references are implemented by special keywords.

:ref:`a_kb` – Optional / Lookup
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, or in tool tips, so this
section is mostly for reference.
This chapter lists all the keyboard shortcuts in novelWriter and what they do. Most of the
shortcuts are also listed next to their menu entries inside the app, or in tool tips. This
chapter is mostly for reference.

:ref:`a_typ` – Optional
This section gives you an overview of the special typographical symbols available in
This chapter gives you an overview of the special typographical symbols available in
novelWriter. The auto-replace feature can handle the insertion of standard quote symbols for
your language, and other special characters. If you use any symbols aside from these. their
intended use is explained here.

:ref:`a_prjfmt` – Optional
This section is more technical and has an overview of changes made to the way your project data
This chapter is more technical and has an overview of changes made to the way your project data
is stored. The format has changed a bit from time to time, and sometimes the changes require
that you make small modifications to your project. Everything you need to know is listed in this
section.
chapter.


Organising Your Projects
Expand All @@ -73,19 +74,19 @@ to take advantage of these features, you must structure your text in a specific
meta data for it to extract.

:ref:`a_proj` – Essential Information
This section explains how you organise the content of your project, and how to set up automated
This chapter explains how you organise the content of your project, and how to set up automated
backups of your work.

:ref:`a_struct` – Essential Information
This section covers the way your novel's structure is encoded into the text documents. It
explains how the different levels of headings are used, and how you can include information
about characters, plot elements, and other meta data in your text.
This chapter covers the way your novel's structure is encoded into the text documents. It
explains how the different levels of headings are used, and some special formatting for
different kinds of headings.

:ref:`a_references` - Recommended Reading
This section explains how you organise your notes, and how the Tags and References system works.
This chapter explains how you organise your notes, and how the Tags and References system works.
This system lets you cross-link your documents in your project, and display these references in
the application interface.

:ref:`a_manuscript` - Recommended Reading
This section explains in more detail how the Manuscript Build tool works, how you can control
the way chapter titles are formatted, and how scene and section breaks are handled.
This chapter explains how the :guilabel:`Manuscript Build` tool works, how you can control the
way chapter titles are formatted, and how scene and section breaks are handled.
12 changes: 6 additions & 6 deletions docs/source/int_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Getting Started
.. _Releases: https://github.com/vkbo/novelWriter/releases
.. _AppImage: https://appimage.org/

Package installers are available for all major platforms, including Linux, Windows and MacOS. See
below for install instructions for each platform.
Package installers for novelWriter are available for all major platforms, including Linux, Windows
and MacOS. See below for install instructions for each platform.

You can also install novelWriter from the Python Package Index (PyPi). See :ref:`a_started_pip`.
Installing from PyPi does not set up icon launchers, so you will either have to do this yourself,
Expand All @@ -37,7 +37,7 @@ Installing it should be straightforward.

If you have any issues, try uninstalling the previous version and making a fresh install. If you
already had a version installed via a different method, you should uninstall that first as having
multiple installations has been known to cause issues.
multiple installations has been known to cause problems.

.. note::
The novelWriter installer is not signed because Microsoft doesn't currently provide a way for
Expand Down Expand Up @@ -112,9 +112,9 @@ completely standalone images for the app that include the necessary environment
They can of course be run on any Linux distro, if you prefer this to native packages.

.. note::

novelWriter generally stops supporting Python versions that have reached end of life. If your
Linux distro still uses older Python versions, you may want to try the AppImage instead.
novelWriter generally don't support Python versions that have reached end of life. If your Linux
distro still uses older Python versions and novelWriter won't run, you may want to try the
AppImage instead.


.. _a_started_macos:
Expand Down
Loading

0 comments on commit ccffa91

Please sign in to comment.