Make some corrections to the docs introduction section (#991)

This commit is contained in:
Veronica Berglyd Olsen
2022-02-12 18:13:17 +01:00
committed by GitHub
parent 45def4b3b7
commit 7f2d51bd15
5 changed files with 28 additions and 25 deletions
+4 -3
View File
@@ -52,13 +52,14 @@ modify it as you like.
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.
For novelWriter to locate the custom theme files, you must copy them to the :ref:`a_locations_data` For novelWriter to be able to locate the custom theme files, you must copy them to the
location in your home or user area. There should be a folder there named ``syntax`` for syntax :ref:`a_locations_data` location in your home or user area. There should be a folder there named
themes and just ``themes`` for GUI themes. ``syntax`` for syntax themes and just ``themes`` for GUI themes.
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.
Theme CSS Files Theme CSS Files
--------------- ---------------
+7 -7
View File
@@ -24,16 +24,16 @@ Below are some key features of novelWriter.
other document you may need to reference while writing. other document you may need to reference while writing.
**Organise your documents how you like** **Organise your documents how you like**
You can split your novel project up into as many individual documents as you want to. They are You can split your novel project up into as many individual documents as you want to. When you
all glued together when you build the project in the top-to-bottom order in which they appear in build the project, they are all glued together in the top-to-bottom order in which they appear
the project tree. Splitting the project up into chapters and scenes means you can easily reorder in the project tree. You can use as few text documents as you like, but splitting the project up
them using the drag and drop feature. into chapters and scenes means you can easily reorder them using the drag and drop feature.
**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
note. In fact, you can add a new tag under each heading of a note if you need to be able to notes. 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 keywords you reference a specific section. Note tags are organised into categories with specific reference
can use to reference them. keywords.
**Get an overview of your plot elements** **Get an overview of your plot elements**
In the :guilabel:`Outline` tab on the main window you can see an outline of all the chapter and In the :guilabel:`Outline` tab on the main window you can see an outline of all the chapter and
+10 -9
View File
@@ -12,10 +12,10 @@ Overview
novelWriter is built on `Python 3 <https://www.python.org/>`_, a cross platform programming novelWriter is built on `Python 3 <https://www.python.org/>`_, a cross platform programming
language that doesn't require a compiler to build and run. That means that the code can run on your language that doesn't require a compiler to build and run. That means that the code can run on your
computer right out of the box, or zip file as it were. 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 just While it is developed for Linux primarily, it runs just fine on Windows as well. It also works fine
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 less attention is paid to that platform.
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
@@ -25,12 +25,13 @@ For install instructions, see :ref:`a_started`.
For information on how to add spell check dictionaries, see :ref:`a_custom_dict`. For information on how to add spell check dictionaries, see :ref:`a_custom_dict`.
Using novelWriter Using novelWriter
================= =================
In order to use novelWriter effectively, you need to know the basics of how it works. The following 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 of with the basics, and gets more detailed as sections will explain the main principles. It starts with the basics, and gets more detailed as you
you read on. read on.
:ref:`a_breakdown` Essential Information :ref:`a_breakdown` Essential Information
This section explains the basics of how the application works and what it can and cannot do. This section explains the basics of how the application works and what it can and cannot do.
@@ -46,7 +47,7 @@ you read on.
: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 purely for shortcuts are also listed next to the menu items inside the app, so this section is mostly for
reference. reference.
:ref:`a_typ` Optional :ref:`a_typ` Optional
@@ -71,8 +72,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 them, and This section explains how you organise the content of your project, how to customise the text,
how to handle archived content and set up automated backups of your work. and how to set up automated 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
@@ -82,7 +83,7 @@ meta data for it to extract.
:ref:`a_notes` - Recommended Reading :ref:`a_notes` - Recommended Reading
This section briefly describes what novelWriter does with the note files you add to your This section briefly describes what novelWriter does with the note files you add to your
project. Generally, the application doesn't do much with them at all aside from looking through project. Generally, the application doesn't do much with them at all aside from looking through
the for tags you've set so that it knows which file to open when you click on a reference. them for tags you've set so that it knows which file to open when you click on a reference.
:ref:`a_export` - Recommended Reading :ref:`a_export` - Recommended Reading
This section explains in more detail how the export tool works. In particular how you can This section explains in more detail how the export tool works. In particular how you can
+1 -1
View File
@@ -82,7 +82,7 @@ With ``setuptools`` in place, novelWriter can be installed to the user space wit
.. tip:: .. tip::
The main setup script has a number of options that may be useful to you. You can list them by The main setup script has a number of options that may be useful to you. You can list them by
running ``python setup.py --help``. running ``python setup.py help``.
.. _a_source_i18n: .. _a_source_i18n:
+6 -5
View File
@@ -28,8 +28,8 @@ installed manually. See :ref:`a_custom_dict` for more details.
.. admonition:: Help Wanted .. admonition:: Help Wanted
:class: seealso :class: seealso
If you would like to help making more installers, the project is currently loooking for people If you would like to help making more installers, the project is currently looking for people
who can help make releases for Reed Hat-based Linux distros (RPM) and for macOS. See the issues who can help make releases for Red Hat-based Linux distros (RPM) and for macOS. See the issues
posted for RPM_ and macOS_ on GitHub_. posted for RPM_ and macOS_ on GitHub_.
@@ -42,7 +42,8 @@ You can install novelWriter with both Python and library dependencies embedded u
Installer (setup.exe) file from the `main website`_, or from the Releases_ page on GitHub. Installer (setup.exe) file from the `main website`_, or from the Releases_ page on GitHub.
Installing it should be straightforward. Installing it should be straightforward.
If you have any issues, try uninstalling the previous version and making a fresh install. 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.
.. _a_started_debian: .. _a_started_debian:
@@ -92,8 +93,8 @@ Then run the update and install commands as for Ubuntu:
.. note:: .. note::
Please use the Ubuntu 20.04 packages for Debian. The newer Ubuntu packages use a different Please use the Ubuntu 20.04 (focal) packages for Debian. The newer Ubuntu packages use a
compression that Debian doesn't currently support. different compression algorithm that Debian doesn't currently support.
.. _a_started_minimal: .. _a_started_minimal: