Skip to content

Commit 09c414c

Browse files
committed
Update docs usage section
1 parent af7b46f commit 09c414c

File tree

4 files changed

+178
-118
lines changed

4 files changed

+178
-118
lines changed

docs/source/usage_breakdown.rst

Lines changed: 78 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ How it Works
88

99
The main features of novelWriter are listed in the :ref:`a_intro` section. Here, we go into some
1010
more details on how they are implemented. Later on in this documentation, these features will be
11-
covered in more detail.
11+
covered in even more detail.
1212

1313

1414
.. _a_breakdown_design:
@@ -19,52 +19,80 @@ GUI Layout and Design
1919
The user interface of novelWriter is intended to be as minimalistic as practically possible, while
2020
at the same time provide a complete set of features needed for writing a novel.
2121

22-
The main window does not have a toolbar like many other applications do. This reduces clutter, and
23-
since the documents are formatted with style tags, is more or less redundant. However, most
24-
formatting features supported are available through convenient keyboard shortcuts. They are also
25-
available in the main menu so you don't have to look up formatting codes every time you need them.
26-
However, a list of all shortcuts can be found in the :ref:`a_kb` section.
22+
The main window does not have an editor toolbar like many other applications do. This reduces
23+
clutter, and since the documents are formatted with style tags, is more or less redundant. However,
24+
most formatting features supported are available through convenient keyboard shortcuts. They are
25+
alsoavailable in the main menu so you don't have to look up formatting codes every time you need
26+
them. However, a list of all shortcuts can be found in the :ref:`a_kb` section.
2727

2828
.. note::
2929
novelWriter is not intended to be a full office type word processor. It doesn't support images,
3030
links, tables, and other complex structures and objects often needed for such documents.
3131
Formatting is limited to headers, emphasis, text alignment, and a few other simple features.
3232

33+
On the left edge of the main window, you will find a sidebar. This bar has buttons for the standard
34+
views you can switch between, a quick link to the :guilabel:`Build Novel Project` tool, and a set
35+
of project-related tools as well as quick access to settings at the bottom.
3336

34-
Window Tabs and Areas
35-
---------------------
3637

37-
The main window is split in two, or optionally three, panels. The left-most panel contains the
38-
project tree and all the documents in your project. The second panel is the document editor. An
39-
optional third panel is a document viewer which can view any document in your project independently
40-
of what is open in the document editor. It is not intended as a preview window, although you can
41-
use it for this as well as it will apply the formatting tags you have specified. The main purpose
42-
of the viewer is for viewing your notes next to your editor while you're writing.
38+
Project Tree View
39+
-----------------
40+
41+
When in :guilabel:`Project Tree View` mode, the main work area of the main window is split in two,
42+
or optionally three, panels. The left-most panel contains the project tree and all the documents in
43+
your project. The second panel is the document editor. An optional third panel is a document viewer
44+
which can view any document in your project independently of what is open in the document editor.
45+
It is not intended as a preview window, although you can use it for this as well as it will apply
46+
the formatting tags you have specified. The main purpose of the viewer is for viewing your notes
47+
next to your editor while you're writing.
4348

4449
The editor also has a :guilabel:`Focus Mode` you can toggle either from the menu, or from the icon
4550
in the editor header. When :guilabel:`Focus Mode` is enabled, all the user interface elements other
4651
than the document editor itself are hidden away.
4752

48-
A second tab is also available on the main window. This is the :guilabel:`Outline` tab where the
49-
entire novel structure can be displayed, with all the tags and references listed. Depending on how
50-
you structure your novel documents, this outline can be quite different from your project tree.
51-
Your project tree lists individual documents, your Outline tree lists the structure of the novel
52-
itself in terms of partitions, chapters and scenes as it appears in the text of those documents.
53+
54+
Novel Tree View
55+
---------------
56+
57+
When in :guilabel:`Novel Tree View` mode, the project tree is replaces by an overview of your novel
58+
structure. Instead of showing individual documents, the tree shows all headings of your novel text.
59+
Each heading is indented according to the heading level. You can open and edit your novel documents
60+
from this view as well. All headings contained in the currently open document should be highlighted
61+
in the view.
62+
63+
If you have multiple Novel root folders, you can switch between them from the dropdown menu from
64+
the buttons at the top of the tree view. You can also select to view an extra column of data. To
65+
select its content, see the menu icon button.
66+
67+
If you click the arrow to the right of each item, a tooltip will pop up showing you all the meta
68+
data collected for that heading entry.
69+
70+
71+
Novel Outline View
72+
------------------
73+
74+
When in :guilabel:`Novel Outline View` mode, the tree, editor and viewer will be replaced by a
75+
large table that shows the entire novel structure with all the tags and references listed. Pretty
76+
much all collected meta data is available here in different columns.
77+
78+
You can select which novel root folder to display from the dropdown box, and you can select which
79+
columns to show or hide from the menu button. You can also rearrange the columns by drag and drop.
5380

5481

5582
Colour Themes
5683
-------------
5784

58-
The colour theme of the user interface defaults to that of the host operating system. Some other
59-
light and dark colour themes are provided, and can be enabled in :guilabel:`Preferences` from the
60-
:guilabel:`Tools` menu. A number of syntax highlighting themes are also available in
61-
:guilabel:`Preferences`. Icon themes for light and dark GUIs are also available. The icons are
62-
based on the Typicons_ icon set designed by Stephen Hutchings.
85+
The default colour theme of the user interface is the default theme from the Qt library. There is a
86+
standard dark theme provided as well, which is similar to the default Qt theme. Some other light
87+
and dark colour themes are also provided. You can select which one you prefer from in
88+
:guilabel:`Preferences` from :guilabel:`Settings` or the :guilabel:`Tools` menu.
89+
90+
A number of syntax highlighting themes are also available in :guilabel:`Preferences`. These are
91+
separate settings because there are a lot more options for syntax highlighting.
6392

6493
.. note::
65-
The GUI colour theme and the syntax highlighting theme are separate settings in
66-
:guilabel:`Preferences`. If you switch to dark mode on the GUI, you should also switch the icon
67-
theme and syntax highlighting theme.
94+
If you switch to dark mode on the GUI, you should also switch the icon theme and syntax
95+
highlighting theme, otherwise icons may be hard to see.
6896

6997

7098
.. _a_breakdown_project:
@@ -75,10 +103,11 @@ Project Layout
75103
This is a brief introduction to how you structure your writing projects. All of this will be
76104
covered in more detail later.
77105

78-
The main point is that you are free to organise your project documents as you wish into subfolders,
79-
and split the text between documents in whatever way suits you. All that matters to novelWriter is
80-
the linear order the documents appear at in the project tree (top to bottom). The chapters, scenes
81-
and sections of the novel are determined by the headings within those documents.
106+
The main point of novelWriter is that you are free to organise your project documents as you wish
107+
into subfolders or subdocuments, and split the text between these documents in whatever way suits
108+
you. All that matters to novelWriter is the linear order the documents appear at in the project
109+
tree (top to bottom). The chapters, scenes and sections of the novel are determined by the headings
110+
within those documents.
82111

83112
The four heading levels (**H1** to **H4**) are treated as follows:
84113

@@ -87,33 +116,40 @@ The four heading levels (**H1** to **H4**) are treated as follows:
87116
* **H3** is used for scene titles – optionally replaced by separators.
88117
* **H4** is for section titles within scenes, if such granularity is needed.
89118

119+
The project tree will select an icon for the document based on the first heading in it.
120+
90121
This header level structure is only taken into account for novel documents. For the project notes,
91122
the header levels have no structural meaning, and the user is free to do whatever they want. See
92123
:ref:`a_struct` and :ref:`a_notes` for more details.
93124

125+
.. note::
126+
You can add documents as child items of other documents if you wish. This is often more useful
127+
than adding folders, since you may want to have the chapter heading in a separate document from
128+
your individual scene documents.
129+
94130

95131
.. _a_breakdown_export:
96132

97-
Project Export
98-
==============
133+
Building the Manuscript
134+
=======================
99135

100-
The project can at any time be exported to a range of different formats through the
101-
:guilabel:`Build Novel Project` tool. Natively, novelWriter supports export to Open Document,
102-
HTML5, and various flavours of Markdown.
136+
The project can at any time be assembled into a range of different formats through the
137+
:guilabel:`Build Novel Project` tool. Natively, novelWriter supports Open Document, HTML5, and
138+
various flavours of Markdown.
103139

104-
The HTML5 export format is suitable for conversion by a number of other tools like Pandoc, or for
140+
The HTML5 format is suitable for conversion by a number of other tools like Pandoc, or for
105141
importing into word processors if the Open Document format isn't suitable. In addition, printing
106142
and printing to PDF is also possible.
107143

108144
You can also export the content of the project to a JSON file. This is useful if you want to write
109-
your own processing script in for instance Python as the entire novel can be read into a Python
145+
your own processing script in for instance Python, as the entire novel can be read into a Python
110146
dictionary with a couple of lines of code. The JSON file can be populated either with HTML
111147
formatted text, or with the raw text as typed into the novel documents. See :ref:`a_export_options`
112148
for more details.
113149

114150
A number of filter options can be applied to the :guilabel:`Build Novel Project` tool, allowing you
115-
to export a draft manuscript, a reference document of notes, an outline based on chapter and scene
116-
titles with a synopsis each, and so on. See :ref:`a_export` for more details on export features and
151+
to make a draft manuscript, a reference document of notes, an outline based on chapter and scene
152+
titles with a synopsis each, and so on. See :ref:`a_export` for more details on build features and
117153
formats.
118154

119155

@@ -132,7 +168,8 @@ project is saved directly to your project folder in separate files. Only the pro
132168
the text you are currently editing is stored in memory at any given time. Secondly, having multiple
133169
small files means it is very easy to sync them between computers with standard file synchronisation
134170
tools. Thirdly, if you use version control software to track the changes to your project, the file
135-
formats used for the files are well suited. Also the JSON documents have line breaks and indents.
171+
formats used for the files are well suited. Also the JSON documents have line breaks and indents,
172+
which makes it easier to track them with version control software.
136173

137174
.. note::
138175

docs/source/usage_format.rst

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -37,34 +37,34 @@ can select them for :guilabel:`Preferences`.
3737
Headings
3838
========
3939

40-
Four levels of headings are allowed. For project notes they are free to be used as you see fit.
41-
That is, novelWriter doesn't assign the different headings any meaning. However, for novel
42-
documents they indicate the structural level of the novel and must be used correctly to produce the
43-
intended result. See :ref:`a_struct_heads` for more details.
40+
Four levels of headings are allowed. For project notes, they are free to be used as you see fit.
41+
That is, novelWriter doesn't assign the different headings any particular meaning. However, for
42+
novel documents they indicate the structural level of the novel and must be used correctly to
43+
produce the intended result. See :ref:`a_struct_heads` for more details.
4444

4545
``# Title Text``
4646
Heading level one. For novel documents, the header level indicates the start of a new partition.
4747

4848
``## Title Text``
4949
Heading level two. For novel documents, the header level indicates the start of a new chapter.
50-
Chapter numbers can be inserted automatically when exporting the manuscript.
50+
Chapter numbers can be inserted automatically when building the manuscript.
5151

5252
``### Title Text``
5353
Heading level three. For novel documents, the header level indicates the start of a new scene.
54-
Scene numbers or scene separators can be inserted automatically when exporting the manuscript,
54+
Scene numbers or scene separators can be inserted automatically when building the manuscript,
5555
so you can use the title field as a working title for your scenes if you wish.
5656

5757
``#### Title Text``
5858
Heading level four. For novel documents, the header level indicates the start of a new section.
59-
Section titles can be replaced by separators or removed completely when exporting the
60-
manuscript.
59+
Section titles can be replaced by separators or removed completely when building the manuscript.
6160

6261
For headers level one and two, adding a ``!`` modifies the behaviour of the heading:
6362

6463
``#! Title Text``
6564
This tells the build tool that the level one heading is intended to be used for the novel's
66-
main title, like for instance on the front page. When exporting, this will use a different
67-
styling and will exclude the title from for instance a Table of Contents in Libre Office.
65+
main title, like for instance on the front page. When building the manuscript, this will use a
66+
different styling and will exclude the title from for instance a Table of Contents in Libre
67+
Office.
6868

6969
``##! Title Text``
7070
This tells the build tool to not assign a chapter number to this chapter title if automatic
@@ -121,7 +121,7 @@ A minimal set of text emphasis styles are supported.
121121
Strikethrough text.
122122

123123
In markdown guides it is often recommended to differentiate between strong importance and emphasis
124-
by using ``**`` for strong and ``_`` for emphasis, although markdown generally also supports ``__``
124+
by using ``**`` for strong and ``_`` for emphasis, although Markdown generally also supports ``__``
125125
for strong and ``*`` for emphasis. However, since the differentiation makes the highlighting and
126126
conversion significantly simpler and faster, in novelWriter this is a rule, not just a
127127
recommendation.
@@ -144,23 +144,23 @@ In addition, the following rules apply:
144144
Comments and Synopsis
145145
=====================
146146

147-
In addition to these standard markdown features, novelWriter also allows for comments in documents.
147+
In addition to these standard Markdown features, novelWriter also allows for comments in documents.
148148
The text of a comment is ignored by the word counter. The text can also be filtered out when
149-
exporting or viewing the document.
149+
building the manuscript or viewing the document.
150150

151151
If the first word of a comment is ``Synopsis:`` (with the colon included), the comment is treated
152152
specially and will show up in the :ref:`a_ui_outline` in a dedicated column. The word ``synopsis``
153153
is not case sensitive. If it is correctly formatted, the syntax highlighter will indicate this by
154154
altering the colour of the word.
155155

156156
``% text...``
157-
This is a comment. The text is not exported by default (this can be overridden), seen in the
157+
This is a comment. The text is not renderred by default (this can be overridden), seen in the
158158
document viewer, or counted towards word counts.
159159

160160
``% Synopsis: text...``
161161
This is a synopsis comment. It is generally treated in the same way as a regular comment, except
162162
that it is also captured by the indexing algorithm and displayed in the :ref:`a_ui_outline`. It
163-
can also be filtered separately when exporting the project to for instance generate an outline
163+
can also be filtered separately when building the project to for instance generate an outline
164164
document of the whole project.
165165

166166
.. note::
@@ -174,8 +174,9 @@ Tags and References
174174
===================
175175

176176
The document editor supports a minimal set of keywords used for setting tags, and making references
177-
between documents. The tags and references can be set once per section defined by a heading. Using
178-
them multiple times under the same heading will just override the previous setting.
177+
between documents. The tag can be set once per section defined by a heading. Setting it multiple
178+
times under the same heading will just override the previous setting. References can be set
179+
anywhere within a section, and are collected according to their category.
179180

180181
``@keyword: value``
181182
A keyword argument followed by a value, or a comma separated list of values.
@@ -226,7 +227,7 @@ Vertical Space and Page Breaks
226227
==============================
227228

228229
Adding more than one line break between paragraphs will *not* increase the space between those
229-
paragraphs when exporting the project. To add additional space between paragraphs, add the text
230+
paragraphs when building the project. To add additional space between paragraphs, add the text
230231
``[VSPACE]`` on a line of its own, and the build tool will insert a blank paragraph in its place.
231232

232233
If you need multiple blank paragraphs just add a colon and a number to the above code. For
@@ -242,6 +243,6 @@ Page breaks are automatically added to partition, chapter and unnumbered chapter
242243
documents. If you want such breaks for scenes and sections, you must add them manually.
243244

244245
.. note::
245-
The page break code is applied to the text that follows. It adds a "page break before" mark to
246-
the text when exporting to HTML or Open Document. This means that a ``[NEW PAGE]`` which has no
247-
text following it will not result in a page break.
246+
The page break code is applied to the text that follows it. It adds a "page break before" mark
247+
to the text when exporting to HTML or Open Document. This means that a ``[NEW PAGE]`` which has
248+
no text following it, it will not result in a page break.

0 commit comments

Comments
 (0)