Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Made a new pass of all the previously updated documentation files

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2020-08-06 22:08:36 +02:00
parent cb8e0231d7
commit 21eebbb88f
10 changed files with 262 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/projects.rst
+69 -66
View File
@@ -7,13 +7,12 @@ 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.
A new project can be created from the :menuselection:`Project` menu by selecting
:menuselection:`New Project`. A list of recently opened projects is maintained, and displayed in the
Open Project dialog. A project can be removed from this list by selecting it and pressing the
:kbd:`Del` key.
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`
dialog. A project can be removed from this list by selecting it and pressing the :kbd:`Del` key.
The project specific settings are available in :menuselection:`Project --> Project Settings`. See
further details below in the :ref:`a_proj_settings` section.
The project specific settings are available in :guilabel:`Project Settings` in the
:guilabel:`Project` menu. See further details below in the :ref:`a_proj_settings` section.
.. _a_proj_roots:
@@ -22,23 +21,26 @@ Project Roots
=============
Projects are structured into a set of top level folders called *root folders*. They are visible in
the Project Tree.
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. A new project will not have all of the root
folders present, but you can add the ones you want from :menuselection:`Project --> Create Root Folder`.
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
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 "Project Structure" section for further details.
See the :ref:`a_struct` page for further details.
Novel
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.
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
This is the root folder where main plots can be outlined. It is optional, but adding at least
@@ -76,8 +78,9 @@ Custom
For more information about the tags listed, see :ref:`a_struct_tags`.
.. note::
Deleted files will be moved into a special "Trash" root folder. Files in the Trash folder can
then be deleted permanently, either individually, or by emptying the trash from the menu.
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.
.. _a_proj_roots_orph:
@@ -86,14 +89,15 @@ Orphaned Documents
------------------
If novelWriter crashes or otherwise exits without saving the project state, or if you're using a
file synchronisation tool, there may be files in the project folder that isn't tracked in the core
project file. These files, when discovered, are handled by the Orphaned Documents routine.
file synchronisation tool that runs out of sync, there may be files in the project folder that isn't
tracked in the core project file. These files, when discovered, are handled by the Orphaned
Documents routine.
Files that are discovered will be re-added to the project tree in a special "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.
Files that are discovered in the project folder, but not in the project, will be re-added to the
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.
.. _a_proj_roots_lock:
@@ -108,7 +112,7 @@ 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.
create diverging project files, potentially resulting in loss of data and orphaned files.
.. note::
If, for some reason, novelWriter crashes, the lock file may remain even if there are no other
@@ -122,47 +126,53 @@ 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, the folders are ignored. Only
the order of the text files themselves matter.
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.
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.
.. tip::
You can use folders to sort your scene files into chapters. You will then need to add a chapter
file as the first file of your folder, and the scene files as the following files.
.. _a_proj_files:
Project Files
=============
New document files can be created from the :menuselection:`Document` menu, or by pressing
:kbd:`Ctrl`:kbd:`N` while in the Project Tree. This will create a new, empty file, and open the Item
Settings dialog where the filename and various other settings can be changed. This dialog can also
be opened again later from either the menu, :menuselection:`Project -> Edit Item`, or by pressing
:kbd:`Ctrl`:kbd:`E` or :kbd:`F2` with the item selected.
New document files can be created from the :guilabel:`Document` menu, or by pressing
:kbd:`Ctrl`:kbd:`N` while in the Project Tree. This will create a new, empty file, and open the
:guilabel:`:Item Settings` dialog where the filename and various other settings can be changed.
This dialog can also be opened again later from either the :guilabel:`Project` menu, selecting
:guilabel:`Edit Item`, or by pressing :kbd:`Ctrl`:kbd:`E` or :kbd:`F2` with the item selected.
The layout of the file is also defined here. For Novel files, the full list of layout options are
available. For non-Novel files, only "Note" is available. See :ref:`a_struct_layout` for more
details.
You can also select whether the file is by default included when building the project. This setting
can be overridden in the Build Novel Project tool if you wish to include them anyway.
can be overridden in the :guilabel:`Build Novel Project` tool if you wish to include them anyway.
.. _a_proj_files_counts:
Word Counts
-----------
A character, word and paragraph count is maintained for each file, as well as dor each section of a
file defined by a header. The word count, and change of words in the current session, is displayed
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.
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 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.
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
full project word recount can be initiated by rebuilding the Project Index. Either form the
:menuselection:`Tools` menu, or by pressing :kbd:`F9`.
values in the project tree, which again depend on an up to date index. If the counts seem wrong, a
full project word recount can be initiated by rebuilding the project's index. Either form the
:guilabel:`Tools` menu, or by pressing :kbd:`F9`.
.. _a_proj_settings:
@@ -170,9 +180,8 @@ full project word recount can be initiated by rebuilding the Project Index. Eith
Project Settings
================
The project settings can be accessed from the :menuselection:`Project --> Project Settings` menu
entry, or by pressing :kbd:`Ctrl`:kbd:`Shift`:kbd:`,`. This will open a dialog box, with a set of
tabs.
The :guilabel:`Project Settings` can be accessed from the :guilabel:`Project` menu, or by pressing
:kbd:`Ctrl`:kbd:`Shift`:kbd:`,`. This will open a dialog box, with a set of tabs.
Settings Tab
@@ -198,36 +207,29 @@ project is saved, how may times it has been saved, how many folders and files it
many words exist in the entire project.
Status Tab
----------
Status and Importance Tabs
---------------------------
Each file of type "Novel" can be given a status level, signified by a coloured icon. These are
purely there for the user's convenience, and you are not required to use them for any other feature
to work. The intention is to use this list to set what stage of writing you are on, although you can
in principle make them whatever you want.
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
can be applied to each file.
These are purely there for the user's convenience, and you are not required to use them for any
other feature to work. No other part of novelWriter accesses this information. The intention is to
use these to indicate at what stage of completeion each novel file is, or how important the content
of a note file is to the plot. You don't have to use them this way, that's just what they were
intended for, but you can make them whatever you want.
.. note::
The status levels currently in use by one or more files cannot be deleted.
Importance Tab
--------------
Each file of types "Plot", "Character", "World", "Timeline", "Object", "Entity", or "Custom", can be
given an importance level, signified by a coloured icon like for status level. These are also purely
there for the user's convenience, and you are not required to use them for any other feature to
work. The intention is to use this list to set how important the character, plot element, or
otherwise, is for the story. Again, these can in principle be used for whatever you want.
.. note::
The importance levels currently in use by one or more files cannot be deleted.
The status or importance level currently in use by one or more files cannot be deleted, but they
can be edited.
Auto-Replace Tab
----------------
A set of automatically replaced keywords can be added in this tab. The keywords in the left column
will be replaced by the text in the right column when documents are opened in the Viewer. They will
will be replaced by the text in the right column when documents are opened in the viewer. They will
also be applied to exports.
.. note::
@@ -246,12 +248,13 @@ backup files are to be stored must to be provided in 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
stored in a subfolder of the backup path with the same name as the project Working Title set in
:ref:`a_proj_settings`.
stored in a subfolder of the backup path with the same name as the project :guilabel:`Working Title`
set in :ref:`a_proj_settings`.
The backup feature, when configured, can also be run manually from the :menuselection:`Tools` menu.
It is also possible to dissable automated backup for a given project in Project 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`.
.. note::
For the backup to be able to run, the Working Title must be set in Project Settings. This value
is used to generate the folder name for the zip files. Without it, the backup will not run.
For the backup to be able to run, the :guilabel:`Working Title` must be set in :guilabel:`Project
Settings`. This value is used to generate the folder name for the zip files. Without it, the
backup will not run at all, but produce a warning message.