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

Further docs edits

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2021-01-01 21:23:41 +01:00
parent 8ad2da30ca
commit a9b5d96d65
8 changed files with 156 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/index.rst
+2 -2
View File
@@ -30,8 +30,8 @@ novelWriter |release|
novelWriter is a markdown-like text editor designed for writing novels and larger projects of many
smaller plain text documents. It uses its own flavour of markdown that supports a meta data syntax
for comments, synopsis and cross-referencing between files. The idea is to have a simple text
editor which allows for easy organisation of text files and notes, built on a plain text file
for comments, synopsis and cross-referencing between documents. The idea is to have a simple text
editor which allows for easy organisation of text documents and notes, built on a plain text file
project repository for robustness.
The plain text storage is suitable for version control software, and also well suited for file
docs/source/int_interface.rst
+56 -53
View File
@@ -16,28 +16,28 @@ The main window contains a project tree in the left-most panel. It shows the ent
the project. It has four columns:
:guilabel:`Label`
The first column shows the item icon and its label. The labels can be edited from the menu
The first column shows the item icon and its label. The labels can be edited from the
:guilabel:`Project` menu, or by pressing :kbd:`F2` or :kbd:`Ctrl`:kbd:`E`. The label is not the
same as the title you set inside the document, but it will appear in the header above the
document text itself.
:guilabel:`Words`
The second column shows the word count of the file, or the sum of words in the child items if it
is a folder. If the counts seem incorrect, they can be updated by rebuilding the project index
from the :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
The second column shows the word count of the document, or the sum of words in the child items
if it is a folder. If the counts seem incorrect, they can be updated by rebuilding the project
index from the :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
:guilabel:`Inc`
The third column indicates whether the file is included in the final project build or not. You
may want to filter out files that you no longer want to keep in the final manuscript, but want
to keep in the project for reference.
The third column indicates whether the document is included in the final project build or not.
You may want to filter out documents that you no longer want to keep in the final manuscript,
but want to keep in the project for reference.
:guilabel:`Flags`
The fourth column shows various meta data flags for the item. The first is an icon indicating
the importance or status of the file. These are colour coded status levels that you control and
define yourself. They can be changed in :guilabel:`Project Settings` from the
the importance or status of the document. These are colour coded status levels that you control
and define yourself. They can be changed in :guilabel:`Project Settings` from the
:guilabel:`Project` menu. The first character after the icon indicates the class of the item,
that is ``N`` for **Novel**, ``C`` for **Character**, etc (see :ref:`a_struct_tags`). The second
character indicates the file layout type (see :ref:`a_proj_roots`).
character indicates the document layout type (see :ref:`a_proj_roots`).
Below the project tree you will find a small details panel showing the full information of the
currently selected item. This panel also includes the latest paragraph and character counts in
@@ -53,16 +53,16 @@ Project Tree Drag and Drop
--------------------------
The project tree allows drag and drop to a certain extent. This feature is primarily intended for
rearranging the order of your files within each root folder, and has only limited support for
moving files elsewhere in the project tree. In general, bulk actions are not allowed. This is
rearranging the order of your documents within each root folder, and has only limited support for
moving documents elsewhere in the project tree. In general, bulk actions are not allowed. This is
deliberate to avoid accidentally messing up your project. The project tree has no undo function.
Document files and their folders can be rearranged freely within their root folders. Novel files
Documents and their folders can be rearranged freely within their root folders. Novel documents
cannot be moved out of the :guilabel:`Novel` folder, except to :guilabel:`Trash` and the
:guilabel:`Outtakes` folder. Note files can be moved freely between root folders.
:guilabel:`Outtakes` folder. Notes can be moved freely between root folders.
Folders cannot be moved at all outside their root tree. Neither can a folder containing files be
deleted. You must first delete the files.
Folders cannot be moved at all outside their root tree. Neither can a folder containing documents
be deleted. You must first delete the containing documents.
Root folders in the project tree cannot be dragged and dropped at all. If you want to reorder them,
you can move them up or down with respect to eachother from the :guilabel:`Tools` menu or the
@@ -75,10 +75,11 @@ key.
Editing and Viewing Documents
=============================
To edit a document, double-click the file in the project tree, or press the :kbd:`Return` key while
having it selected. This will open the file in the document editor. The editor uses a simplified
markdown format. The format is described in the :ref:`a_ui_md` section below. The editor has a
maximise button (activates :guilabel:`Focus Mode`) and a close button in the top-right corner.
To edit a document, double-click it in the project tree, or press the :kbd:`Return` key while
having it selected. This will open the document in the document editor. The editor uses a
simplified markdown format. The format is described in the :ref:`a_ui_md` section below. The editor
has a maximise button (activates :guilabel:`Distraction Free Mode`) and a close button in the
top-right corner.
Any document in the project tree can also be viewed in parallel in a right hand side document
viewer. To view a document, press :kbd:`Ctrl`:kbd:`R`, or select :guilabel:`View Document` in the
@@ -89,10 +90,10 @@ with your latest changes. You can also press the reload button in the top-right
panel next to the close button to achieve the same thing.
Both the document editor and viewer will show the label of the document in the header at the top of
the edit or view panel. Optionally, the full project path to the file can be shown. This can be set
in the :guilabel:`Preferences` dialog from the :guilabel:`Tools` menu. Clicking on the document
title bar will select and reveal the file in the project tree, making it easier to find the project
location of the file in a large project.
the edit or view panel. Optionally, the full project path to the document can be shown. This can be
set in the :guilabel:`Preferences` dialog from the :guilabel:`Tools` menu. Clicking on the document
title bar will select and reveal its location in the project tree, making it easier to find in a
large project.
Any reference to a tag in the editor can be opened in the viewer by moving the cursor to the label
and pressing :kbd:`Ctrl`:kbd:`Return`. In the viewer, the references become clickable links.
@@ -153,28 +154,28 @@ a synopsis tag, and a set of keyword and value sets used for tags and references
Headings
--------
Four levels of headings are allowed. For files of type "Note", they are free to be used as you see
fit, but for all other file layouts used for the novel text itself, they indicate the structural
Four levels of headings are allowed. For documents of layout "Note", they are free to be used as
you see fit, but for all other layouts used for the novel text itself, they indicate the structural
level of the novel. See :ref:`a_struct_heads` for more details.
``# Title``
Heading level one. If the file is a novel file, the header level indicates the start of a new
partition. This heading level can also be used for the title page novel title.
Heading level one. If the document is a novel file, the header level indicates the start of a
new partition. This heading level can also be used for the title page novel title.
``## Title``
Heading level two. If the file is a novel file, the header level indicates the start of a new
chapter.
Heading level two. If the document is a novel file, the header level indicates the start of a
new chapter.
``### Title``
Heading level three. If the file is a novel file, the header level indicates the start of a new
scene.
Heading level three. If the document is a novel file, the header level indicates the start of a
new scene.
``#### Title``
Heading level four. If the file is a novel file, the header level indicates the start of a new
section.
Heading level four. If the document is a novel file, the header level indicates the start of a
new section.
.. note::
The space after the ``#`` characters is mandatory. The syntaxhighlighter will change colour and
The space after the ``#`` characters is mandatory. The syntax highlighter will change colour and
font size when the heading is correctly formatted.
@@ -198,7 +199,9 @@ In markdown guides it is often recommended to differentiate between strong impor
by using ``**`` for strong and ``_`` for emphasis, although markdown generally also supports ``__``
for strong and ``*`` for emphasis. However, since the differentiation makes the highlighting and
conversion significantly simpler and faster, in novelWriter this is a rule, not just a
recommendation. The following is therefore the only supported formatting syntax:
recommendation.
In addition, the following rules apply:
1. The emphasis and strikethrough formatting tags do not allow spaces between the words and the tag
itself. That is, ``**text**`` is valid, ``**text **`` is not.
@@ -216,12 +219,12 @@ recommendation. The following is therefore the only supported formatting syntax:
Comments and Synopsis
---------------------
In addition to these standard markdown features, novelWriter also allows for comments in the text
files. The text of the comment is ignored by the word counter and not exported or, optionally,
hidden when viewing the document. If the first word of a comment is ``Synopsis:`` (with the colon),
the comment is treated specially and will show up in the :ref:`a_ui_outline` in a dedicated column.
The word ``synopsis`` is not case sensitive. If it is correctly formatted, the syntax highlighter
will indicate this by altering the colour of the word.
In addition to these standard markdown features, novelWriter also allows for comments in document.
The text of the comment is ignored by the word counter and not exported or, optionally, hidden when
viewing the document. If the first word of a comment is ``Synopsis:`` (with the colon), the comment
is treated specially and will show up in the :ref:`a_ui_outline` in a dedicated column. The word
``synopsis`` is not case sensitive. If it is correctly formatted, the syntax highlighter will
indicate this by altering the colour of the word.
``% text...``
A comment. The text is not exported by default (this can be overridden), seen in the Viewer, or
@@ -244,8 +247,8 @@ Tags and References
-------------------
The document editor supports a minimal set of keywords used for setting tags, and making references
between files. The tags and references can be set once per section defined by a heading. Using them
multiple times under the same heading will just override the previous setting.
between documents. The tags and references can be set once per section defined by a heading. Using
them multiple times under the same heading will just override the previous setting.
``@keyword: value``
A keyword argument followed by a value, or a comma separated list of values.
@@ -261,7 +264,7 @@ Additional Markdown and Non-Standard Features
The editor and viewer also supports markdown standard hard line breaks, and preserves non-breaking
spaces if running with Qt 5.9 or higher. For older versions, the non-breaking spaces are lost when
the file is saved. This is unfortunately hard-coded in the Qt text editor.
the document is saved. This is unfortunately hard-coded in the Qt text editor.
* A hard line break is achieved by leaving two or more spaces at the end of the line.
Alternatively, the user can press :kbd:`Ctrl`:kbd:`K`, :kbd:`Return` to insert this.
@@ -284,16 +287,16 @@ Project Outline View
The project's Outline view is available as the second tab on the right hand side of the main window
labelled :guilabel:`Outline`. The outline provides an overview of the novel structure, displaying a
tree hierarchy of the elements of the novel, that is, the level 1 to 4 headings, not the files.
tree hierarchy of the elements of the novel, that is, the level 1 to 4 headings.
The document file containing the heading can also be displayed as a separate column, as well as the
line number where it occurs. Double-clicking an entry will open the corresponding file in the
The document containing the heading can also be displayed as a separate column, as well as the line
number where it occurs. Double-clicking an entry will open the corresponding document in the
editor.
.. note::
Since the internal structure of the novel does not depend on the file structure of the project
tree, these will not necessarily look the same, depending how you choose to organise your files.
See the :ref:`a_struct` page for more details.
Since the internal structure of the novel does not depend directly on the folder and document
structure of the project tree, these will not necessarily look the same, depending how you
choose to organise your documents. See the :ref:`a_struct` page for more details.
Various meta data and information extracted from tags can be displayed in columns in the outline.
A default set of such columns is visible, but you can turn on or off more columns by right clicking
@@ -405,8 +408,8 @@ Insert Shortcuts
----------------
A set of insert features are also available through shortcuts, but they require a double
combination of key sequences. The insert feature is activated with :kbd:`Ctrl-K`, followed by a key
or combination for the inserted character or punctuation.
combination of key sequences. The insert feature is activated with :kbd:`Ctrl`:kbd:`K`, followed by
a key or combination for the inserted character or punctuation.
.. csv-table:: Keyboard Shortcuts
:header: "Shortcut", "Description"
docs/source/int_introduction.rst
+18 -17
View File
@@ -12,15 +12,15 @@ projects are structured is covered on the :ref:`a_struct` page.
In addition, the project can contain notes on the various plot elements, characters, locations,
etc, that make up the story. These notes are organised in a set of category-specific top-level
folders (root folders), and each entry can be tagged and cross-referenced from within the novel
files and other note files. These tags make it possible to inter-link documents, and generate an
overview of the entire novel project and how the various files and plot elements are
interconnected. This is covered on the :ref:`a_proj` and :ref:`a_notes` pages.
documents and notes. These tags make it possible to inter-link documents, and generate an overview
of the entire novel project and how the various documents and plot elements are interconnected.
This is covered on the :ref:`a_proj` and :ref:`a_notes` pages.
These additional features are not standard in markdown, but are available through special meta
keywords described on :ref:`a_struct_tags`. Syntax highlighting is provided to make it easier to
keywords described in :ref:`a_struct_tags`. Syntax highlighting is provided to make it easier to
verify that the markdown tags are used correctly.
An overview of the extended markdown syntax is covered on the :ref:`a_ui` page.
An overview of the supported markdown syntax is covered on the :ref:`a_ui` page.
.. _a_intro_design:
@@ -33,7 +33,7 @@ at the same time provide a complete set of features needed for writing a novel.
.. note::
novelWriter is not intended to be a full office type word processor. It doesn't support images,
links, tables, and other complex structure and objects often needed for such document.
links, tables, and other complex structures and objects often needed for such documents.
Formatting is limited to headers, and bold, italicised and strikethrough text.
The main window does not have a toolbar like most other applications do. This reduces clutter, and
@@ -52,13 +52,14 @@ of icon themes in colour and greyscale are also offered. The icons are based on
set designed by Stephen Hutchings.
The main window is split in two, or optionally three, panels. The left-most contains the project
tree and all the files in your project. The second panel is the document editor, and the optional
third panel is a document viewer which can view any document in your project.
tree and all the documents in your project. The second panel is the document editor, and the
optional third panel is a document viewer which can view any document in your project.
A second tab is also available on the main window. This is the :guilabel:`Outline` tab where the
entire novel structure can be displayed, with all the tags and references listed. Depending on how
you structure your novel project files, this outline can be quite different from your project tree.
Your project tree lists files, your Outline tree lists the structure of the novel itself.
you structure your novel documents, this outline can be quite different from your project tree.
Your project tree lists individual documents, your Outline tree lists the structure of the novel
itself as it appears in the text of the documents.
.. _Typicons: https://github.com/stephenhutchings/typicons.font
@@ -68,10 +69,10 @@ Your project tree lists files, your Outline tree lists the structure of the nove
Project Layout
==============
You are free to structure your project files as you wish in subfolders, and split the text between
files in whatever way suits you. All that matters to novelWriter is the linear order the files
appear at in the project tree (top to bottom). The chapters, scenes and sections of the novel are
determined by the headings within those files.
You are free to structure your project documents as you wish in subfolders, and split the text
between documents in whatever way suits you. All that matters to novelWriter is the linear order
the documents appear at in the project tree (top to bottom). The chapters, scenes and sections of
the novel are determined by the headings within those documents.
The four heading levels (**H1** to **H4**) are treated as follows:
@@ -80,9 +81,9 @@ The four heading levels (**H1** to **H4**) are treated as follows:
* **H3** is used for scene titles – optionally replaced by separators.
* **H4** is for section titles within scenes, if such granularity is needed.
This header level structure is only taken into account for novel files. For the files designated as
project notes, the header levels have no structural meaning, and the user is free to do whatever
they want. See the :ref:`a_struct` page for more details.
This header level structure is only taken into account for novel documents. For the project notes,
the header levels have no structural meaning, and the user is free to do whatever they want. See
the :ref:`a_struct` and :ref:`a_notes` pages for more details.
.. _a_intro_export:
docs/source/int_started.rst
+1 -6
View File
@@ -45,11 +45,6 @@ needed for novelWriter to run, including Python and the xml and Qt libraries.
.. _main website: https://novelwriter.io
.. note::
While the majority of virus scanners have no warnings, some scanners will flag the installer.
This is caused by the ``pyinstaller`` tool being used to create the package. The ``pyinstaller``
binaries bundled with the installer are from the official PyPi repository.
.. _a_started_install_source:
@@ -122,7 +117,7 @@ The spell checking extension is optional, but recommended:
* ``pyenchant``, needed for efficient spell checking.
The optional spell check library must be at least 3.0.0 to work with Windows. On Linux, 2.0.0 also
The optional spell check library must be at least 3.0 to work with Windows. On Linux, 2.0 also
works fine.
docs/source/write_export.rst
+6 -6
View File
@@ -56,7 +56,7 @@ a series of keyword–replace steps. They are all on the format ``%keyword%``.
**Example**
* The format ``%title%`` just reproduces the title you set in the document file.
* The format ``%title%`` just reproduces the title you set in the document.
* The format ``Chapter %ch%: %title%`` produces something like "Chapter 1: My Chapter Title".
* The format ``Scene %ch%.%sc%`` produces something like "Scene 1.2" for scene 2 in chapter 1.
@@ -79,11 +79,11 @@ separator.
File Selection
==============
Which document files are selected for export can be controlled from the options on the left side of
the dialog window. The switch for :guilabel:`Include novel files` will select any document that
isn't classified as a note. The switch for :guilabel:`Include note files` will select any document
that *is* a note. This is allows for exporting just the novel, just your notes, or both, as you see
fit.
Which documents and notes are selected for export can be controlled from the options on the left
side of the dialog window. The switch for :guilabel:`Include novel files` will select any document
that isn't classified as a note. The switch for :guilabel:`Include note files` will select any
document that *is* a note. This is allows for exporting just the novel, just your notes, or both,
as you see fit.
In addition, you can select to export the synopsis comments, regular comments, keywords, and even
exclude the body text itself.
docs/source/write_notes.rst
+4 -4
View File
@@ -1,8 +1,8 @@
.. _a_notes:
************************
Supporting Files (Notes)
************************
*************
Project Notes
*************
novelWriter doesn't have a database and complicated forms to fill in all details about plot
elements, characters, and all sorts of additional information that isn't a part of the novel text
@@ -10,7 +10,7 @@ itself. Instead, all such information is saved in notes. The relation between al
elements is extracted from these documents by the project indexer based on the tags and references
you set.
These documents are not required, but making at least minimal files for each such plot element, and
These notes are not required, but making at least minimal files for each such plot element, and
adding a tag to them, makes it possible to use the :guilabel:`Outline` feature to see how each
element intersects with each section of the novel itself, and adds clickable cross-references
between documents in the editor and viewer.
docs/source/write_projects.rst
+62 -61
View File
@@ -26,9 +26,9 @@ 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 :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.
The core novel documents go into a root folder of type :guilabel:`Novel`. Other supporting
documents 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 may 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.
@@ -37,17 +37,17 @@ The root folders are intended for the following use, but aside from the :guilabe
no restrictions are enforced by the application. You can use them however you want.
: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.
This is the root folder of all text that goes into the final novel. This class of documents have
other rules and features than other documents in the project. See the :ref:`a_struct` page for
more details.
: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
dummy notes can be useful in order to tag plot elements for the Outline view. Tags in this
folder can be references using the ``@plot`` keyword.
:guilabel:`Characters`
Character files go in this root folder. These are especially important if one wants to use the
Character notes 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
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.
@@ -58,7 +58,7 @@ no restrictions are enforced by the application. You can use them however you wa
: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``
notes can be used to track this. Tags in this folder can be references using the ``@time``
keyword.
:guilabel:`Objects`
@@ -88,13 +88,14 @@ information about the tags listed, see :ref:`a_struct_tags`.
Deleted Documents
-----------------
Deleted document files will be moved into a special :guilabel:`Trash` root folder. Files in the
Deleted documents will be moved into a special :guilabel:`Trash` root folder. Documents in the
trash folder can then be deleted permanently, either individually, or by emptying the trash from
the menu. Files in this folder are removed from the project index and cannot be referenced.
the menu. Documents in the trash folder are removed from the project index and cannot be
referenced.
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`.
supported. A document or a folder can be deleted from the :guilabel:`Project` menu, or by pressing
:kbd:`Ctrl`:kbd:`Del`.
.. _a_proj_roots_out:
@@ -102,15 +103,15 @@ pressing :kbd:`Ctrl`:kbd:`Del`.
Archived Documents (Outtakes)
-----------------------------
If you don't want to delete a file, or put it in the :guilabel:`Trash` folder where it may be
If you don't want to delete a document, or put it in the :guilabel:`Trash` folder where it may be
deleted, but still want it out of your main project tree, you can create an :guilabel:`Outtakes`
root folder from the :guilabel:`Project` menu. You are not allowed to move folders to this root
folder, only files. If you need folders in it to organise your files, you can of course create new
ones there.
folder, only documents. If you need folders in it to organise your documents, you can of course
create new ones there.
You can drag any file to this folder and preserve its settings. The file will always be excluded
from the :guilabel:`Build Novel Project` builds. The file is also removed from the project index,
so the tags and references defined in it will not show up anywhere else.
You can drag any document to this folder and preserve its settings. The document will always be
excluded from the :guilabel:`Build Novel Project` builds. It is also removed from the project
index, so the tags and references defined in it will not show up anywhere else.
.. _a_proj_roots_orph:
@@ -123,17 +124,17 @@ file synchronisation tool that runs out of sync, there may be files in the proje
aren't tracked in the core project file. These files, when discovered, are recovered and added back
into the project if possible.
The discovered files are scanned for meta information that gives clues as to where the file may
The discovered files are scanned for meta information that gives clues as to where the document may
previously have been located in the project. The project loading routines will try to put them back
as close as possible to this location, if it still exists. Generally, it will be appended to the
end of the folder where it previously was located. If that folder doesn't exist, it will try to add
it to the correct root folder. If it cannot figure out which root folder is correct, the file will
be added to the :guilabel:`Novel` root folder. Only if the :guilabel:`Novel` folder is missing, it
will give up.
it to the correct root folder. If it cannot figure out which root folder is correct, the document
will be added to the :guilabel:`Novel` root folder. Only if the :guilabel:`Novel` folder is
missing will it give up.
If the title of the file can be recovered, the word "Recovered:" will be added as a prefix. If the
title cannot be determined, the file will be named "Recovered File N" where N is a sequential
number.
If the title of the document can be recovered, the word "Recovered:" will be added as a prefix. If
the title cannot be determined, the document will be named "Recovered File N" where N is a
sequential number.
.. _a_proj_roots_lock:
@@ -141,7 +142,7 @@ number.
Project Lockfile
----------------
To prevent lost files caused by file conflicts when novelWriter projects are synced with file
To prevent lost documents 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 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
@@ -165,32 +166,33 @@ 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 document files themselves matter.
is processing the documents in the novel, like for instance during export, these folders are
ignored. Only the order of the documents 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 collapse and hide them in the project tree when you're not working on those files.
The folders are there purely as a way for the user to organise the documents in meaningful sections
and to be able to collapse and hide them in the project tree when you're not working on those
documents.
.. 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.
You can use folders to sort your scene documents into chapters. You will then need to add a
chapter documents as the first item of your folder, and the scene documents as the following
items.
.. _a_proj_files:
Project Files
=============
Project Documents
=================
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 Project Item`, or by pressing :kbd:`Ctrl`:kbd:`E` or :kbd:`F2` with the item
selected.
New documents 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 document, and open the :guilabel:`Item
Settings` dialog where the document label and various other settings can be changed. This dialog
can also be opened again later from either the :guilabel:`Project` menu, selecting :guilabel:`Edit
Project 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.
The layout of the document is also defined here. For Novel documents, the full list of layout
options are available. For non-Novel documents, only :guilabel:`Note` is available. See
:ref:`a_struct_layout` for more details.
You can also select whether the document 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
@@ -206,7 +208,7 @@ Word Counts
A character, word and paragraph count is maintained for each document, as well as for each section
of a document following 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.
panel below the project tree for any document selected in the project tree.
The word counts are not updated in real time, but run in the background every five seconds for as
long as the document is being actively edited.
@@ -238,35 +240,34 @@ Title` should remain unchanged throughout the project, otherwise the name of exp
backup files may change too.
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 may be
using them, and they are exported on some export formats in the :guilabel:`Build Novel Project`
tool.
anything, so setting then is just for the benefit of the author. Future features may be using them,
and they are exported on some export formats in the :guilabel:`Build Novel Project` tool.
Details Tab
-----------
This tab presents an overview of meta data for the project. It states where on your file system the
project is saved, how may times it has been saved, how many folders and files it contains, and how
many words exist in the entire project.
project is saved, how may times it has been saved, how many folders and documents it contains, and
how many words exist in the entire project.
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 can be applied to each file.
Each document or folder of type :guilabel:`Novel` can be given a status level, signified by a
coloured icon, and each document or folder of the remaining types can be given an importance level.
These are colour coded icons and labels that can be applied to each document or folder.
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 completion 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
other features to work. No other part of novelWriter accesses this information. The intention is to
use these to indicate at what stage of completion each novel document is, or how important the
content of a note 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 or importance level currently in use by one or more files cannot be deleted, but they
can be edited.
The status or importance level currently in use by one or more documents cannot be deleted, but
they can be edited.
Auto-Replace Tab
@@ -313,9 +314,9 @@ Settings`.
Writing Statistics
==================
When you work on your project, a log file records when you opened it, when you closed it, and the
latest total word counts of your novel and note files after the session. You can view this file in
the ``meta`` folder in the directory where you saved your project. The file is named
When you work on a project, a log file records when you opened it, when you closed it, and the
total word counts of your novel documents and notes at the end of the session. You can view this
file in the ``meta`` folder in the directory where you saved your project. The file is named
``sessionStats.log``.
A tool to view the content of this file is available in the :guilabel:`Tools` menu under
docs/source/write_structure.rst
+7 -7
View File
@@ -6,8 +6,8 @@ Novel Structure
This section covers the structure of a novel project.
It concerns documents under the Novel type root folder only. There are some restrictions and
features that only apply to these types of documents.
It concerns documents under the :guilabel:`Novel` type root folder only. There are some
restrictions and features that only apply to these types of documents.
.. _a_struct_heads:
@@ -76,8 +76,8 @@ removed before inserted at the location of the ``%title%`` label. See the :ref:`
more details.
.. note::
If you need the first character of the title to be an actual asterisk, you must escape it like
so: ``\*``.
If you need the first character of the title to be an actual asterisk, you must escape it:
``\*``.
.. _a_struct_tags:
@@ -86,9 +86,9 @@ Tag References
==============
Each text partition indicated by a heading of any level, can contain references to tags set in the
supporting documents of the project. The references are gathered by the indexer and used to
generate the outline view on the :guilabel:`Outline` tab of how the different parts of the novel
are connected.
supporting notes of the project. The references are gathered by the indexer and used to generate
the outline view on the :guilabel:`Outline` tab of how the different parts of the novel are
connected.
References and tags are also clickable in the document editor and viewer, making it easy to
navigate between reference notes while writing. Clicked links are always opened in the view panel.