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

Updated documentation for export and the user interface

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2019-10-27 15:44:40 +01:00
parent aba339f8e3
commit 43ebcec4e9
7 changed files with 122 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/projects.txt
+15 -10
View File
@@ -1,5 +1,6 @@
##############
Novel Projects
==============
##############
A novelWriter project requires a dedicated folder for storing its files.
See the Technical Information section for further details.
@@ -10,8 +11,9 @@ A list of recently opened projects is also maintained and can be selected from t
The project specific settings are available in :menuselection:`Project --> Project Settings`.
See further details below.
*****************
Project Structure
^^^^^^^^^^^^^^^^^
*****************
Projects are structured into a set of root folders, visible in the left side tree view panel.
@@ -36,7 +38,7 @@ Deleted files will be moved into a special "Trash" root folder.
Currently, these files cannot be permanently deleted from the project.
Orphaned Documents
~~~~~~~~~~~~~~~~~~
==================
In the event the editor crashes or otherwise exits without saving the project state, files that have been added to the project tree and are saved to disk will appear in a special "Orphaned Items" root folder next time the application is started.
These orphaned files will not have any meta data associated with them, so the title and other information has to be set again, and the files moved back to the correct location in the project.
@@ -44,14 +46,15 @@ Using Project Folders
Folders, aside from root folders, have no structural significance to the project. They 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 tree view. When processing the files in the novel, the folders are ignored.
****************
Project Settings
^^^^^^^^^^^^^^^^
****************
The project settings can be accessed from the :menuselection:`Project --> Project Settings` menu entry.
This will open a dialog box.
Settings Tab
~~~~~~~~~~~~
============
The Settings tab holds the project title and author settings.
Working Title can be set to a different title than the Book Title.
@@ -62,7 +65,7 @@ The Book Authors text box takes one author per line.
The line breaks matter in that this is converted to a list for later correct formatting.
Status Tab
~~~~~~~~~~
==========
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.
@@ -71,7 +74,7 @@ The intention is to use this list to set what stage of writing you are on, altho
Note that status levels currently in use by a file cannot be deleted.
Importance Tab
~~~~~~~~~~~~~~
==============
Each file of types PLOT, CHARACTER, WORLD, TIMELINE, OBJECT 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.
@@ -81,7 +84,7 @@ Again, these can in principle be used for whatever you want.
Note that importance levels currently in use by a file cannot be deleted.
Auto-Replace Tab
~~~~~~~~~~~~~~~~
================
A set of automatically replaced keywords can be added in this tab.
The keywords in the left column wile be replaced by the text in the right column when documents are opened in the viewer.
@@ -91,8 +94,9 @@ Note that a keyword cannot contain any spaces.
The angle brackets are added by default, and when used in the text are a part of the keyword to be replaced.
This is to ensure that parts of the text isn't unintentionally replaced by the content of the list.
*************
Writing Files
^^^^^^^^^^^^^
*************
New document files can be created from the Document menu, or by pressing Ctrl+N while in the tree view pane.
This will create a new, empty file, and open the item settings dialog where the filename and various other settings can be set.
@@ -100,8 +104,9 @@ This dialog can also be opened again later from either the menu, :menuselection:
The different classes of documents have some restrictions.
******
Backup
^^^^^^
******
An automatic backup system is built into novelWriter.
In order to use it, a backup path to where the backups are to be stored needs to be provided in :menuselection:`Tools --> Preferences`.