Made another pass of editing of the entire documentation
This commit is contained in:
Veronica K. B. Olsen
+66
-47
@@ -5,7 +5,7 @@ Novel Projects
|
||||
**************
|
||||
|
||||
A novelWriter project requires a dedicated folder for storing its files on the local file system.
|
||||
See the :ref:`a_tech` page for further details.
|
||||
See the :ref:`a_tech` page for further details on how files are organised.
|
||||
|
||||
A new project can be created from the :guilabel:`Project` menu by selecting :guilabel:`New Project`.
|
||||
A list of recently opened projects is maintained, and displayed in the :guilabel:`Open Project`
|
||||
@@ -23,64 +23,77 @@ Project Roots
|
||||
Projects are structured into a set of top level folders called *root folders*. They are visible in
|
||||
the project tree at the left side of the main window.
|
||||
|
||||
The core novel files go into a root folder of type "Novel". Other supporting files go into the other
|
||||
root folders. These other root folder types are intended for your notes on the various elements of
|
||||
your story. Using these is of course entirely optional.
|
||||
The core novel files go into a root folder of type :guilabel:`Novel`. Other supporting files go into
|
||||
the other root folders. These other root folder types are intended for your notes on the various
|
||||
elements of your story. Using these is of course entirely optional.
|
||||
|
||||
A new project will not have all of the root folders present, but you can add the ones you want from
|
||||
:guilabel:`Create Root Folder` in the :guilabel:`Project` menu.
|
||||
|
||||
The root folders are intended for the following use, but aside from the Novel folder, no
|
||||
The root folders are intended for the following use, but aside from the :guilabel:`Novel` folder, no
|
||||
restrictions are enforced by the application. You can use them however you want.
|
||||
|
||||
.. note::
|
||||
The root folders correspond to the categories of tags that can be used.
|
||||
See the :ref:`a_struct` page for further details.
|
||||
|
||||
Novel
|
||||
:guilabel:`Novel`
|
||||
This is the root folder of all text that goes into the final novel. This class of files have
|
||||
other rules and features than other files in the project. See the :ref:`a_struct` page for more
|
||||
details.
|
||||
|
||||
Plot
|
||||
:guilabel:`Plot`
|
||||
This is the root folder where main plots can be outlined. It is optional, but adding at least
|
||||
dummy files can be useful in order to tag plot elements for the Outline View. Tags in this folder
|
||||
dummy files can be useful in order to tag plot elements for the Outline view. Tags in this folder
|
||||
can be references using the ``@plot`` keyword.
|
||||
|
||||
Characters
|
||||
:guilabel:`Characters`
|
||||
Character files go in this root folder. These are especially important if one wants to use the
|
||||
Outline View to see which character appears where, and which part of the story is told from a
|
||||
Outline view to see which character appears where, and which part of the story is told from a
|
||||
specific character's point-of-view. Tags in this folder can be references using the ``@pov``
|
||||
keyword for point-of-view characters, or the ``@char`` keyword for other characters.
|
||||
|
||||
Locations
|
||||
:guilabel:`Locations`
|
||||
The locations folder is for various scene locations that you want to track. Tags in this folder
|
||||
can be references using the ``@location`` keyword.
|
||||
|
||||
Timeline
|
||||
:guilabel:`Timeline`
|
||||
If the story has multiple plot timelines or jumps in time within the same plot, this class of
|
||||
files can be used to track this. Tags in this folder can be references using the ``@time``
|
||||
keyword.
|
||||
|
||||
Objects
|
||||
:guilabel:`Objects`
|
||||
Important objects in the story, for instance important objects that change hands often, can be
|
||||
tracked here. Tags in this folder can be references using the ``@object`` keyword.
|
||||
|
||||
Entities
|
||||
:guilabel:`Entities`
|
||||
Does your plot have many powerful organisations or companies? Or other entities that are part of
|
||||
the plot? They can be organised here. Tags in this folder can be references using the ``@entity``
|
||||
keyword.
|
||||
|
||||
Custom
|
||||
:guilabel:`Custom`
|
||||
The custom root folder can be used for tracking anything else not covered by the above options.
|
||||
Tags in this folder can be references using the ``@custom`` keyword.
|
||||
|
||||
For more information about the tags listed, see :ref:`a_struct_tags`.
|
||||
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`.
|
||||
|
||||
.. note::
|
||||
Deleted files will be moved into a special :guilabel`Trash` root folder. Files in the trash
|
||||
folder can then be deleted permanently, either individually, or by emptying the trash from the
|
||||
menu.
|
||||
.. tip::
|
||||
You can rename root folders to whatever you want. The first character in the :guilabel:`Flags`
|
||||
column will still indicate what type they are, and so will the icon if you are using one of the
|
||||
Typicons icon sets.
|
||||
|
||||
|
||||
.. _a_proj_roots_del:
|
||||
|
||||
Deleted Documents
|
||||
-----------------
|
||||
|
||||
Deleted document files will be moved into a special :guilabel:`Trash` root folder. Files in the
|
||||
trash folder can then be deleted permanently, either individually, or by emptying the trash from the
|
||||
menu.
|
||||
|
||||
Folders and root folders can only be deleted when they are empty. Recursive deletion is not
|
||||
supported.
|
||||
|
||||
A document file or a folder can be deleted from the :guilabel:`project` menu, or by pressing
|
||||
:kbd:`Ctrl`:kbd:`Del`.
|
||||
|
||||
|
||||
.. _a_proj_roots_orph:
|
||||
@@ -97,7 +110,7 @@ Files that are discovered in the project folder, but not in the project, will be
|
||||
project tree in a special :guilabel:`Orphaned Items` root folder next time the application is
|
||||
started. These orphaned files will not have most of the meta data preserved, although novelWriter
|
||||
will try to restore the file label it had in the project tree. Other information will have to be set
|
||||
again, and the files moved back to the correct location in the project.
|
||||
again, and the files moved back to the correct location in the project tree.
|
||||
|
||||
|
||||
.. _a_proj_roots_lock:
|
||||
@@ -107,18 +120,20 @@ Project Lockfile
|
||||
|
||||
To prevent orphaned files caused by file conflicts when novelWriter projects are synced with file
|
||||
synchronisation tools, a project lockfile is written to the project folder. If you try to open a
|
||||
project which has such a file, you will be presented with a warning, and some information about
|
||||
where else novelWriter thinks the project is also open.
|
||||
|
||||
You will be give the option to ignore this warning, and continue opening the project. However, if
|
||||
multiple instances are in fact editing the same project, you are likely to cause inconsistencies and
|
||||
create diverging project files, potentially resulting in loss of data and orphaned files.
|
||||
project which 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 give the option to ignore
|
||||
this warning, and continue opening the project.
|
||||
|
||||
.. note::
|
||||
If, for some reason, novelWriter crashes, the lock file may remain even if there are no other
|
||||
instances keeping the project open. In such a case it is safe to ignore the lock file warning
|
||||
when re-opening the project.
|
||||
|
||||
.. warning::
|
||||
If you choose to ignore the warning and continue opening the project, and multiple instances of
|
||||
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.
|
||||
|
||||
|
||||
.. _a_proj_roots_dirs:
|
||||
|
||||
@@ -127,11 +142,10 @@ Using Folders in the Project Tree
|
||||
|
||||
Folders, aside from root folders, have no structural significance to the project. When novelWriter
|
||||
is processing the files in the novel, like for instance during export, these folders are ignored.
|
||||
Only the order of the text files themselves matter.
|
||||
Only the order of the document files themselves matter.
|
||||
|
||||
The folders are there purely as a way for the user to organise the files in meaningful sections and
|
||||
to be able to close them in the Project Tree when you're not working on those files, and thus reduce
|
||||
clutter.
|
||||
to be able to collapse and hide them in the project tree when you're not working on those files.
|
||||
|
||||
.. tip::
|
||||
You can use folders to sort your scene files into chapters. You will then need to add a chapter
|
||||
@@ -155,6 +169,7 @@ details.
|
||||
|
||||
You can also select whether the file is by default included when building the project. This setting
|
||||
can be overridden in the :guilabel:`Build Novel Project` tool if you wish to include them anyway.
|
||||
This is covered in the :ref:`a_export_files` section.
|
||||
|
||||
|
||||
.. _a_proj_files_counts:
|
||||
@@ -167,7 +182,8 @@ file defined by a header. The word count, and change of words in the current ses
|
||||
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 file selected.
|
||||
|
||||
The word counts are not updated in real time, but runs in the background every five seconds.
|
||||
The word counts are not updated in real time, but runs in the background every five seconds for as
|
||||
long as the document is being actively edited.
|
||||
|
||||
A total project word count is displayed in the status bar. The total count depends on the sum of the
|
||||
values in the project tree, which again depend on an up to date index. If the counts seem wrong, a
|
||||
@@ -187,16 +203,18 @@ The :guilabel:`Project Settings` can be accessed from the :guilabel:`Project` me
|
||||
Settings Tab
|
||||
------------
|
||||
|
||||
The Settings tab holds the project title and author settings.
|
||||
The :guilabel:`Settings` tab holds the project title and author settings.
|
||||
|
||||
Working Title can be set to a different title than the Book Title. The difference between them is
|
||||
simply that the Working Title is used for the GUI (main window title) and for generating the backup
|
||||
files. The intention is that the working title should remain unchanged throughput the project,
|
||||
otherwise the name of exported files and backup files may change too.
|
||||
The :guilabel:`Working Title` can be set to a different title than the :guilabel:`Book Title`. The
|
||||
difference between them is simply that the :guilabel:`Working Title` is used for the GUI (main
|
||||
window title) and for generating the backup files. The intention is that the :guilabel:`Working
|
||||
Title` should remain unchanged throughput the project, otherwise the name of exported files and
|
||||
backup files may change too.
|
||||
|
||||
The Book Title amd Book Authors settings are currently not used for anything, so setting then is
|
||||
just for the benefit of the author. Future, planned features will be using them, and they are
|
||||
exported on some export formats in the Build Novel Project tool.
|
||||
The :guilabel:`Book Title` and :guilabel:`Book Authors` settings are currently not used for
|
||||
anything, so setting then is just for the benefit of the author. Future, planned features will be
|
||||
using them, and they are exported on some export formats in the :guilabel:`Build Novel Project`
|
||||
tool.
|
||||
|
||||
|
||||
Details Tab
|
||||
@@ -207,8 +225,8 @@ project is saved, how may times it has been saved, how many folders and files it
|
||||
many words exist in the entire project.
|
||||
|
||||
|
||||
Status and Importance Tabs
|
||||
---------------------------
|
||||
Status and Importance Tabs
|
||||
--------------------------
|
||||
|
||||
Each file of type "Novel" can be given a status level, signified by a coloured icon and each file of
|
||||
the remaining types can be given an importance level. These are colour coded icons and labels that
|
||||
@@ -244,7 +262,7 @@ Backup
|
||||
======
|
||||
|
||||
An automatic backup system is built into novelWriter. In order to use it, a backup path to where the
|
||||
backup files are to be stored must to be provided in Preferences.
|
||||
backup files are to be stored must to be provided in :guilabel:`Preferences`.
|
||||
|
||||
Backups can be run automatically when a project is closed, which also implies it is run when the
|
||||
application is closed. Backups are date stamped zip files of the entire project folder, and are
|
||||
@@ -252,7 +270,8 @@ stored in a subfolder of the backup path with the same name as the project :guil
|
||||
set in :ref:`a_proj_settings`.
|
||||
|
||||
The backup feature, when configured, can also be run manually from the :guilabel:`Tools` menu.
|
||||
It is also possible to dissable automated backup for a given project in :guilabel:`Project Settings`.
|
||||
It is also possible to dissable automated backup for a given project in :guilabel:`Project
|
||||
Settings`.
|
||||
|
||||
.. note::
|
||||
For the backup to be able to run, the :guilabel:`Working Title` must be set in :guilabel:`Project
|
||||
|
||||
Reference in New Issue
Block a user