Clean up the "User Interface" section

This commit is contained in:
Veronica Berglyd Olsen
2025-05-26 22:39:03 +02:00
parent acfef7b4cb
commit caa1a7653d
8 changed files with 161 additions and 156 deletions
+2 -4
View File
@@ -62,7 +62,7 @@ storage for robustness.
user_interface/statistics user_interface/statistics
.. toctree:: .. toctree::
:caption: Additional Features :caption: Other Features
:hidden: :hidden:
features/dialogue features/dialogue
@@ -71,8 +71,7 @@ storage for robustness.
features/shortcuts features/shortcuts
.. toctree:: .. toctree::
:maxdepth: 1 :caption: In-Depth Topics
:caption: Special Topics
:hidden: :hidden:
more/counting more/counting
@@ -82,7 +81,6 @@ storage for robustness.
more/project_format more/project_format
.. toctree:: .. toctree::
:maxdepth: 1
:caption: Technical Topics :caption: Technical Topics
:hidden: :hidden:
+2 -1
View File
@@ -55,7 +55,8 @@ An alternative format of a tag is ``@tag: TagName | Display Name``.
After a tag has been defined, it can be referenced in novel documents, or cross-referenced in other After a tag has been defined, it can be referenced in novel documents, or cross-referenced in other
notes. Tags will also show up in the **Outline View** and in the **References** panel under the notes. Tags will also show up in the **Outline View** and in the **References** panel under the
document viewer when a document is open in the viewer. document viewer when a document is open in the viewer. See :ref:`docs_ui_main_outline` and
:ref:`docs_ui_edit_view_view_references` for more details.
The editor will indicate to you that the keyword is correctly used and that the tag is allowed, The editor will indicate to you that the keyword is correctly used and that the tag is allowed,
that is, the tag is unique, by adding a colour highlighting to it. An invalid tag should have a that is, the tag is unique, by adding a colour highlighting to it. An invalid tag should have a
+73 -69
View File
@@ -20,8 +20,7 @@ Editing a Document
To edit a document, double-click it in the project tree, press the :kbd:`Return` key while having To edit a document, double-click it in the project tree, press the :kbd:`Return` key while having
it selected, or drag and drop it onto the editor panel. This will open the document in the document it selected, or drag and drop it onto the editor panel. This will open the document in the document
editor. The editor uses a Markdown-like syntax for some features, and a novelWriter-specific syntax editor.
for others.
The editor has a maximise button, which toggles the **Focus Mode**, and a close button in the The editor has a maximise button, which toggles the **Focus Mode**, and a close button in the
top--right corner. On the top--left side you will find a tools button that opens a toolbar with a top--right corner. On the top--left side you will find a tools button that opens a toolbar with a
@@ -37,35 +36,33 @@ be shown. This can be set in **Preferences**.
Clicking on the document title bar will select the document in the project tree and thus reveal Clicking on the document title bar will select the document in the project tree and thus reveal
its location there, making it easier to find in a large project. its location there, making it easier to find in a large project.
Any references in the editor can be opened in the viewer by moving the cursor to Any references in the editor can be opened in the viewer by moving the cursor to the label and
the label and pressing :kbd:`Ctrl+Return`. You can also control-click them with your mouse. pressing :kbd:`Ctrl+Return`. You can also control-click them with your mouse.
Spell Checking Spell Checking
-------------- --------------
A third party library called Enchant is used for spell checking in the editor. The controls for A third party library called Enchant is used for spell checking in the editor. The controls for
spell checking can be found in the **Tools** menu. You can also set spell checking language in spell checking are found in the **Tools** menu. You can also set spell checking language in
**Project Settings**. **Project Settings**.
This spell checking library comes with support for custom words that you can add by selecting This spell checking library comes with support for custom words that you can add by selecting
"Add Word to Dictionary" from the context menu when a word is highlighted by the spell checker as "Add Word to Dictionary" from the context menu when a word is highlighted by the spell checker as
misspelled. The custom words are managed on a per-project basis, and can the list of words can be misspelled. The custom words are managed on a per-project basis, and the list of words can be
edited from the **Project Word List** tool available from the **Tools** menu. edited from the **Project Word List** tool available from the **Tools** menu.
.. note:: .. note::
Generally, spell checking dictionaries are collected from your operating system, but on Windows Generally, spell checking dictionaries are collected from your operating system, but on Windows
they are not. See :ref:`docs_more_custom_dict` for how to add spell checking dictionaries on Windows. they are not. See :ref:`docs_more_custom_dict` for how to add spell checking dictionaries on
Windows.
.. versionadded:: 2.2
Word Counts Word Counts
----------- -----------
A character, word and paragraph count is maintained for each document, as well as for each section A character, word, and paragraph count is maintained for each document, as well as for each section
of a document following a heading. The word count and change of words in the current session is of a document following a heading. 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 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 document selected in the project or novel trees. panel below the project tree for any document selected in the project or novel trees.
@@ -74,57 +71,18 @@ The word counts are not updated in real time, but run in the background every fe
long as the document is being actively edited. 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 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 project index. If the the values in the project tree, which again depend on an up to date project index. If the counts
counts seem wrong, a full project word recount can be initiated by rebuilding the project's index. seem wrong, a full project word recount can be initiated by rebuilding the project's index. Either
Either from the **Tools** menu, or by pressing :kbd:`F9`. from the **Tools** menu, or by pressing :kbd:`F9`.
The rules for how the counts are made is covered in more detail in :ref:`docs_more_counting`. The rules for how the counts are made is covered in more detail in :ref:`docs_more_counting`.
.. tip::
.. _docs_ui_edit_view_view: For some languages, character count is the more interesting statistics. You can select to
display character count instead of word count in the user interface in **Preferences**.
Viewing a Document .. versionadded:: 2.7
==================
.. figure:: images/fig_viewer.png
A screenshot of the Document Viewer panel.
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+R`, select **View Document** in the menu or context
menu, or drag and drop the document onto the viewer panel. If you have a middle mouse button,
middle-clicking on the document will also open it in the viewer.
The document viewed does not have to be the same document as the one currently being edited.
However, If you *are* viewing the same document, pressing :kbd:`Ctrl+R` from the editor will update
the document with your latest changes. You can also press the reload button in the top--right
corner of the viewer panel, next to the close button, to achieve the same thing.
In the viewer `references<reference>` become clickable links. Clicking them will replace the
content of the viewer with the content of the document the reference points to.
The document viewer keeps a history of viewed documents, which you can navigate with the arrow
buttons in the top--left corner of the viewer. If your mouse has backward and forward navigation
buttons, these can be used as well. They work just like the backward and forward features in a
browser. The left-most button is a dropdown menu for quickly navigation between headings in the
document. The edit button on the right will open the viewed document in the editor.
At the bottom of the view panel there is a **References** panel. (If it is hidden, click the button
on the left side of the footer area to reveal it.) This panel contains a References tab with links
to all documents referring back to the one you're currently viewing, if any has been defined. If
you have created root folders and tags for various story elements like characters and plot points,
these will appear as additional tabs in this panel.
.. note::
The **References** panel relies on an up-to-date `index<project index>` of the project.
The index is maintained automatically. However, if anything is missing, or seems wrong, the
index can always be rebuilt by selecting **Rebuild Index** from the **Tools** menu, or by
pressing :kbd:`F9`.
.. versionadded:: 2.2
The reference panel was redesigned and the additional tabs added.
.. _docs_ui_edit_view_search: .. _docs_ui_edit_view_search:
@@ -150,12 +108,6 @@ document when reaching the end. There is also a switch that will try to match th
when the replacement is made. That is, it will try to keep the word upper, lower, or capitalised to when the replacement is made. That is, it will try to keep the word upper, lower, or capitalised to
match the word being replaced. match the word being replaced.
.. seealso::
For more information on the capabilities of the Regular Expression option, see the Qt
documentation for the `QRegularExpression <https://doc.qt.io/qt-6/qregularexpression.html>`_
class.
.. _docs_ui_edit_view_auto: .. _docs_ui_edit_view_auto:
@@ -171,14 +123,66 @@ auto-replace feature from **Preferences**. You can also disable this feature ent
the :guilabel:`Insert` menu, and via :ref:`docs_features_shortcuts_insert`. You may also be the :guilabel:`Insert` menu, and via :ref:`docs_features_shortcuts_insert`. You may also be
using a `Compose Key`_ setup, which means you may not need the auto-replace feature at all. using a `Compose Key`_ setup, which means you may not need the auto-replace feature at all.
The editor is able to replace two and three hyphens with short and long dashes, triple points with The editor is able to replace two and three hyphens with short and long dashes, four dashes with a
ellipsis, and replace straight single and double quotes with user-defined quote symbols. It will horizontal bar, three dots with ellipsis, and replace straight single and double quotes with
also try to determine whether to use the opening or closing symbol, although this feature isn't user-defined quote symbols. It will also try to determine whether to use the opening or closing
always accurate. Especially distinguishing between closing single quote and apostrophe can be symbol, although this feature isn't always accurate. Especially distinguishing between closing
tricky for languages that use the same symbol for these, like English does. single quote and apostrophe can be tricky for languages that use the same symbol for these, like
English does.
.. tip:: .. tip::
If the auto-replace feature changes a symbol when you did not want it to change, pressing If the auto-replace feature changes a symbol when you did not want it to change, pressing
:kbd:`Ctrl+Z` once after the auto-replacement will undo it without undoing the character :kbd:`Ctrl+Z` once after the auto-replacement will undo it without undoing the character
you typed before it. you typed.
.. _docs_ui_edit_view_view:
Viewing a Document
==================
.. figure:: images/fig_viewer.png
A screenshot of the Document Viewer panel.
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+R`, select **View Document** in the menu or context
menu, or drag and drop the document onto the viewer panel. If you have a middle mouse button,
middle-clicking on the document will also open it in the viewer.
The document viewed does not have to be the same document as the one currently being edited.
However, If you *are* viewing the same document, pressing :kbd:`Ctrl+R` from the editor will update
the document with your latest changes. You can also press the reload button in the top--right
corner of the viewer panel, next to the close button, to achieve the same thing.
In the viewer, references become clickable links. Clicking them will replace the content of the
viewer with the content of the document the reference points to.
The document viewer keeps a history of viewed documents, which you can navigate with the arrow
buttons in the top--left corner of the viewer. If your mouse has backward and forward navigation
buttons, these can be used as well. They work just like the backward and forward features in a
browser. The left-most button is a dropdown menu for quickly navigation between headings in the
document. The edit button on the right will open the viewed document in the editor.
.. _docs_ui_edit_view_view_references:
Document References
-------------------
At the bottom of the viewer panel you will find a **References** panel. (If it is hidden, click the
button on the left side of the footer area to reveal it.) This panel contains a References tab with
links to all documents referring back to the one you're currently viewing, if any has been defined.
If you have created root folders and tags for various story elements like characters and plot
points, these will appear as additional tabs in this panel.
.. note::
The **References** panel relies on an up-to-date project index. The index is maintained
automatically. However, if anything is missing, or seems wrong, the index can always be rebuilt
by selecting **Rebuild Index** from the **Tools** menu, or by pressing :kbd:`F9`.
.. versionadded:: 2.2
The reference panel was redesigned and the additional tabs added.
+26 -31
View File
@@ -12,12 +12,12 @@ reduces clutter, and since the documents are formatted with style tags, it is no
the time. Still, a small formatting toolbar can be popped out by clicking the left-most button in the time. Still, a small formatting toolbar can be popped out by clicking the left-most button in
the header of the document editor. It gives quick access to standard formatting codes. the header of the document editor. It gives quick access to standard formatting codes.
Most formatting features supported are available through convenient keyboard shortcuts. They are Most formatting features supported are also available through keyboard shortcuts, as well as
also available in the main menu under **Format**, so you don't have to look up formatting codes available in the main menu under **Format**, so you don't have to look up formatting codes every
every time you need them. For reference, a list of all shortcuts can be found in the time you need them. For reference, a list of all shortcuts can be found in the
:ref:`docs_features_shortcuts` section. :ref:`docs_features_shortcuts` section.
On the left side of the main window, you will find a sidebar. This bar has buttons for the standard On the left side of the main window you will find a sidebar. This bar has buttons for the standard
views you can switch between, a quick link to the **Build Manuscript** tool, and a set of views you can switch between, a quick link to the **Build Manuscript** tool, and a set of
project-related tools and quick access to settings at the bottom. project-related tools and quick access to settings at the bottom.
@@ -29,9 +29,9 @@ Project Tree and Editor View
A screenshot of the Project Tree and Editor View. A screenshot of the Project Tree and Editor View.
When the application is in **Project Tree View** mode, the work area of the main window is split in When **Project Tree View** in the sidebar is selected, the work area is split in two, or
two, or optionally three, panels. The left-most panel contains the project tree and all the optionally three, panels. The left-most panel contains the project tree and all the documents in
documents in your project. The second panel is the document editor. your project. The second panel is the document editor.
An optional third panel on the right side contains a document viewer which can view any document in An optional third panel on the right side contains a document viewer which can view any document in
your project independently of what is open in the document editor. This panel is not intended as a your project independently of what is open in the document editor. This panel is not intended as a
@@ -46,18 +46,13 @@ elements other than the document editor itself are hidden away.
The project tree will highlight with a different background colour the document that is currently The project tree will highlight with a different background colour the document that is currently
open in the editor. open in the editor.
.. versionadded:: 2.6
You can now drag and drop documents from the project tree onto the editor or viewer panels to
open them.
Drag & Drop Drag & Drop
----------- -----------
The project tree allows drag & drop to allow you to reorder your documents and folders. Moving a The project tree allows drag & drop so you to reorder your documents and folders. Moving a document
document in the project tree will affect the text's position when you assemble your manuscript in in the project tree will affect the text's position when you assemble your manuscript in the
the **Manuscript Build** tool. **Manuscript Build** tool.
Documents and their folders can be rearranged freely within their root folders. If you move a Documents and their folders can be rearranged freely within their root folders. If you move a
**Novel Document** out of a **Novel** folder, it will be converted to a **Project Note**. Notes can **Novel Document** out of a **Novel** folder, it will be converted to a **Project Note**. Notes can
@@ -67,7 +62,7 @@ type root folder, its "Importance" setting will be replaced by a "Status" settin
and should be restored if you move it back at some point. and should be restored if you move it back at some point.
Root folders in the project tree cannot be dragged and dropped at all. If you want to reorder them, 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 each other from the arrow buttons at the top of the you can move them up or down with respect to each other using the arrow buttons at the top of the
project tree, or by pressing :kbd:`Ctrl+Up` or :kbd:`Ctrl+Down` when they are selected. project tree, or by pressing :kbd:`Ctrl+Up` or :kbd:`Ctrl+Down` when they are selected.
.. tip:: .. tip::
@@ -93,10 +88,10 @@ Novel View and Editor View
A screenshot of the Novel Tree and Editor View. A screenshot of the Novel Tree and Editor View.
When the application is in **Novel Tree View** mode, the project tree is replaced by an overview of When **Novel Tree View** in the sidebar is selected, the project tree is replaced by an overview of
your novel structure for a specific Novel root folder. Instead of showing individual your novel structure for a specific **Novel** type root folder. Instead of showing individual
documents, the tree now shows all headings of your novel text. This includes multiple headings documents, the tree now shows all headings of your text. This includes multiple headings within the
within the same document. same document.
Each heading is indented according to the heading level, not its parent/child relationship to other Each heading is indented according to the heading level, not its parent/child relationship to other
elements of your project. You can open and edit your novel documents from this view as well. All elements of your project. You can open and edit your novel documents from this view as well. All
@@ -122,9 +117,9 @@ meta data collected for that heading.
.. note:: .. note::
You cannot reorganise the entries in the novel view, or add any new documents, as that would You cannot reorganise the entries in the novel view, or add any new documents, as that would
imply restructuring the content of the document files themselves. Any such editing must be done imply restructuring the content of the documents themselves. Any such editing must be done in
in the project tree. However, you can add new headings to existing documents, or change the project tree. However, you can add new headings to existing documents, or change references,
references, which will be updated in this view when the document is saved. which will be updated in this view when the document is saved.
.. _docs_ui_main_outline: .. _docs_ui_main_outline:
@@ -136,14 +131,14 @@ Novel Outline View
A screenshot of the Novel Outline View. A screenshot of the Novel Outline View.
When the application is in **Novel Outline View** mode, the tree, editor and viewer are replaced by When **Novel Outline View** in the sidebar is selected, the tree, editor and viewer are replaced by
a large table that shows the entire novel structure with all the tags and references listed. You a table that shows the entire novel structure with all the tags and references listed. You can
can select which novel folder to display from the dropdown menu. You can optionally choose to show select which novel folder to display from the dropdown menu. You can optionally choose to show a
a combination of all novel folders. combination of all novel folders.
Pretty much all collected meta data is available in this view, and you can select which columns to Pretty much all collected meta data is available in this view. You can select which columns to
display from the menu button. This includes various meta data and information extracted from your display from the menu button. This includes various meta data and information extracted from your
:ref:`docs_usage_tags_refs`. The order of the columns can also be rearranged by dragging them to a :ref:`docs_usage_tags_refs`. The order of the columns can also be changed by dragging them to a
different position. You column settings are saved between sessions on a per-project basis. different position. You column settings are saved between sessions on a per-project basis.
.. note:: .. note::
@@ -180,7 +175,7 @@ whichever of the two is visible. If one of them already has focus, the key press
between them instead. between them instead.
Likewise, pressing :kbd:`Ctrl+E` will switch focus to the document editor or viewer, or if any of Likewise, pressing :kbd:`Ctrl+E` will switch focus to the document editor or viewer, or if any of
them already have focus, it will switch focus between them, them already have focus, it will switch focus between them.
These two shortcuts make it possible to jump between all these GUI elements without having to reach These two shortcuts make it possible to jump between all these GUI elements without having to reach
for the mouse or touchpad. for the mouse or touchpad.
@@ -198,7 +193,7 @@ If you wish, you *can* create your own colour themes, and even have them added t
See :ref:`docs_more_custom_theme` for more details. See :ref:`docs_more_custom_theme` for more details.
Switching the GUI colour theme does not affect the colours of the editor and viewer. They have Switching the GUI colour theme does not affect the colours of the editor and viewer. They have
separate colour selectable from the "Document colour theme" setting in **Preferences**. They are separate themes selectable from the "Document colour theme" setting in **Preferences**. They are
separated because there are a lot more options to choose from for the editor and viewer. separated because there are a lot more options to choose from for the editor and viewer.
.. note:: .. note::
+39 -34
View File
@@ -10,11 +10,14 @@ You can at any time build a manuscript, an outline of your notes, or any other t
from the text in your project. All of this is handled by the **Manuscript Build** tool. You can from the text in your project. All of this is handled by the **Manuscript Build** tool. You can
activate it from the sidebar, the **Tools** menu, or by pressing :kbd:`F5`. activate it from the sidebar, the **Tools** menu, or by pressing :kbd:`F5`.
.. note::
The term "Build" in this context means to assemble or generate a single document from a
selection of your project documents. You can select between multiple standard document formats.
.. versionadded:: 2.1 .. versionadded:: 2.1
This tool is new for version 2.1. A simpler tool was used for earlier versions. The simpler tool This tool is new for version 2.1. A simpler tool was used for earlier versions.
only allows you to define a single set of options for the build, but otherwise had much the same
functionality.
.. _docs_ui_manuscript_main: .. _docs_ui_manuscript_main:
@@ -43,9 +46,9 @@ Outline and Word Counts
The **Outline** tab on the left lets you navigate the headings in the preview document. It will The **Outline** tab on the left lets you navigate the headings in the preview document. It will
show up to scene level headings for novel documents, and level 2 headings for notes. show up to scene level headings for novel documents, and level 2 headings for notes.
A collapsible panel of word and character counts are also available below the preview document. A collapsible panel of word and character counts is also available below the preview pane. These
These are calculated from the text you have included in the document, and are more accurate counts are calculated from the text you have included in the document, and are more accurate counts than
than what's available in the project tree since they are counted *after formatting*. what's available in the project tree since they are counted *after formatting*.
For a detailed description on how they are counted, see :ref:`docs_more_counting`. For a detailed description on how they are counted, see :ref:`docs_more_counting`.
@@ -55,15 +58,15 @@ For a detailed description on how they are counted, see :ref:`docs_more_counting
Build Settings Build Settings
============== ==============
Each build definition can be edited by opening it in the **Manuscript Build Settings** dialog, You can edit a build definition by opening it in the **Manuscript Build Settings** dialog, either
either by double-clicking or by selecting it and pressing the edit button in the toolbar. by double-clicking or by selecting it and pressing the edit button in the toolbar.
.. tip:: .. tip::
You can keep the **Manuscript Build Settings** dialog open while testing the different options, You can keep the **Manuscript Build Settings** dialog open while testing the different options,
and just hit the :guilabel:`Apply` button. You can test the result of your settings by pressing and just hit the :guilabel:`Apply` button. You can test the result of your settings change by
the :guilabel:`Preview` button in the main **Manuscript Build** window. When you're happy with pressing the :guilabel:`Preview` button in the main **Manuscript Build** window. When you're
the result, you can close the settings. happy with the result, you can close the settings.
.. _docs_ui_manuscript_selection: .. _docs_ui_manuscript_selection:
@@ -77,16 +80,16 @@ Document Selection
The **Selections** page of the **Manuscript Build Settings** dialog. The **Selections** page of the **Manuscript Build Settings** dialog.
The **Selections** page of the **Manuscript Build Settings** dialog allows you to fine tune which The **Selections** page of the **Manuscript Build Settings** dialog allows you to fine tune which
documents are included in the build. They are indicated by a green arrow icon in the last column. documents are included in the build. The included documents are indicated by an icon in the last
On the right you have some filter options for selecting content of a specific type, and a set of column. On the right you have some filter options for selecting content of a specific type, and a
switches for which root folders to include. set of switches for which root folders to include.
You can override the result of these filters by marking one or more documents and selecting to You can override the result of these filters by marking one or more documents and selecting to
explicitly include or exclude them by using the buttons below the tree view. The last button can be explicitly include or exclude them by using the buttons below the tree view. The last button can be
used to reset the override and return control to the filter settings. used to reset the override and return control to the filter settings.
In the figure, the green arrow icon and the blue pin icon indicates which documents are included, In the figure, the orange icon and the blue icon indicates which documents are included, and the
and the red forbidden icon indicates that a document is explicitly excluded. red icon indicates that a document is explicitly excluded.
By default, inactive documents are excluded, but you can override this in the filter settings. By default, inactive documents are excluded, but you can override this in the filter settings.
See :ref:`docs_usage_project_active` for more details. See :ref:`docs_usage_project_active` for more details.
@@ -139,13 +142,13 @@ You can preview the result of these format strings by clicking :guilabel:`Apply`
Automatic Numbering Automatic Numbering
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
The headings formatter also allows you to automatically insert chapter and scene numbers into your The headings formatter allows you to automatically insert chapter and scene numbers into your
heading formats. The automatic chapter number counter will skip all chapter headings marked as headings. The automatic chapter number counter will skip all chapter headings marked as unnumbered
unnumbered using the heading format described in :ref:`docs_usage_headings_levels`. using the heading format described in :ref:`docs_usage_headings_levels`.
Scene numbers are mostly intended for use in a draft manuscript. You can either insert absolute Scene numbers are mostly intended for use in a draft manuscript. You can either insert absolute
scene numbers that counts every scene in the novel, or you can insert per-chapter scene numbers scene numbers that counts every scene in the novel, or you can insert per-chapter scene numbers
that reset to 1 for each chapter. that reset to 1 for each new chapter.
:bdg-info:`Example` :bdg-info:`Example`
@@ -167,12 +170,13 @@ Scene Separators
If you don't want any titles for your scenes (or for your sections if you have them), you can leave If you don't want any titles for your scenes (or for your sections if you have them), you can leave
the formatting boxes empty. If so, an empty paragraph will be inserted between the scenes or the formatting boxes empty. If so, an empty paragraph will be inserted between the scenes or
sections instead, resulting in a gap in the text. You can also switch on the :guilabel:`Hide` sections instead, resulting in a gap in the text. You can also enable the :guilabel:`Hide` setting,
setting, which will ignore them completely. That is, there won't even be an extra gap inserted. which will ignore them completely. That is, there won't even be an extra gap inserted.
Alternatively, if you want a separator text between them, like the common ``* * *``, you can enter Alternatively, if you want a separator text between them, like the common ``* * *``, you can enter
the desired separator text as the format. If the format is any piece of static text, it will always the desired separator text as the format. If the format is any piece of static text, it will always
be treated as a separator. be treated as a separator. A static separator is only inserted between scenes, as opposed to a
formatted heading which is also inserted before the first scene of a chapter.
.. _docs_ui_manuscript_head_hard_soft: .. _docs_ui_manuscript_head_hard_soft:
@@ -184,15 +188,17 @@ If you wish to distinguish between so-called soft and hard scene breaks, you can
alternative scene heading format in your text. You can then give these headings a different alternative scene heading format in your text. You can then give these headings a different
formatting in the **Headings** settings. formatting in the **Headings** settings.
See :ref:`docs_usage_headings_levels` for more info on how to format headings in your text. See :ref:`docs_usage_headings_levels` for more info on how to format alternative scene headings in
your text.
Output Settings Output Settings
--------------- ---------------
The **Content**, **Format** and **Output** pages of the **Manuscript Build Settings** dialog The **Formatting** sections of the **Manuscript Build Settings** dialog control a number of other
control a number of other settings for the output. Some of these only apply to specific output settings for the output. This includes formatting, but also what content is included. You can for
formats, which is indicated by the section headings on the settings pages. instance select to include comments, synopsis. tags and reference, and even exclude the body text
itself.
.. _docs_ui_manuscript_build: .. _docs_ui_manuscript_build:
@@ -220,14 +226,14 @@ show the build progress, but for small projects it may pass very fast.
File Formats File Formats
------------ ------------
Currently, four document formats are supported. The following document formats are supported:
Open Document Format Open Document
The Build tool can produce either an ``.odt`` file, or an ``.fodt`` file. The latter is just a The Build tool can produce either an ``.odt`` file, or an ``.fodt`` file. The latter is just a
flat version of the document format as a single XML file. Most rich text editors support the flat version of the document format as a single XML file. Most rich text editors support the
former, and only a few the latter. former, and only a few the latter.
Microsoft Word Document Format Microsoft Word Document
The Microsoft Word Document format writes a single ``.docx`` file. It uses a fairly basic format The Microsoft Word Document format writes a single ``.docx`` file. It uses a fairly basic format
that should be compatible with most rich text editors. that should be compatible with most rich text editors.
@@ -261,8 +267,7 @@ Additional Formats
------------------ ------------------
In addition to the above document formats, the novelWriter HTML and Markup formats can also be In addition to the above document formats, the novelWriter HTML and Markup formats can also be
wrapped in a JSON file. These files will have a meta data entry and a body entry. For HTML, also wrapped in a JSON file. These files will have a meta data entry and a body entry.
the accompanying CSS styles used by the preview are included.
The text body is saved in a two-level list. The outer list contains one entry per document, in the The text body is saved in a two-level list. The outer list contains one entry per document, in the
order they appear in the project tree. Each document is then split up into a list as well, with one order they appear in the project tree. Each document is then split up into a list as well, with one
@@ -283,5 +288,5 @@ on the print dialog.
.. note:: .. note::
The paper format should in all cases default to whatever your system default is. If you want to The paper format should default to whatever your system default is. If you want to change it,
change it, you have to select it from the **Print Preview** dialog. you have to select it from the **Print Preview** dialog.
+9 -8
View File
@@ -20,7 +20,7 @@ This will open the **Welcome** dialog, where you can select the :guilabel:`New`
assist you in creating a project. This dialog is also displayed when you start novelWriter. assist you in creating a project. This dialog is also displayed when you start novelWriter.
A novelWriter project requires a dedicated folder for storing its files on the local file system. A novelWriter project requires a dedicated folder for storing its files on the local file system.
If you're interested in the details, you can have a look at the section If you're interested in the details of how projects are stored, you can have a look at the section
:ref:`docs_technical_storage`. :ref:`docs_technical_storage`.
A list of recently opened projects is maintained, and displayed in the **Welcome** dialog. A A list of recently opened projects is maintained, and displayed in the **Welcome** dialog. A
@@ -44,8 +44,8 @@ Template Projects
From the Welcome dialog you can also create a new from another existing project. If you have a From the Welcome dialog you can also create a new from another existing project. If you have a
specific structure you want to use for all your new projects, you can create a dedicated project to specific structure you want to use for all your new projects, you can create a dedicated project to
be used as a template, and select to copy an existing project from the :guilabel:"Prefill Project" be used as a template, and select to copy an existing project from the "Prefill Project" option
option from the **New Project** form. from the **New Project** form.
.. _docs_ui_projects_settings: .. _docs_ui_projects_settings:
@@ -66,7 +66,7 @@ The **Project Name** can be edited here. It is used for the main window title an
backup files. So keep in mind that if you do change this setting, the backup file names will change backup files. So keep in mind that if you do change this setting, the backup file names will change
too. too.
You can also change the **Authors** and **Project Language** setting. These are only used when You can also change the **Author** and **Project Language** setting. These are only used when
building the manuscript, for some formats. The language setting is also used when inserting text building the manuscript, for some formats. The language setting is also used when inserting text
into documents in the viewer, like for instance labels for keywords and special comments. into documents in the viewer, like for instance labels for keywords and special comments.
@@ -100,8 +100,7 @@ See also :ref:`docs_usage_project_status`.
.. note:: .. note::
The status or importance level currently in use by one or more documents cannot be deleted, but Status or importance level currently in use cannot be deleted, but they can be edited.
they can be edited.
Text Auto-Replace Text Auto-Replace
@@ -116,6 +115,7 @@ highlighter will add an alternate colour to text matching the syntax, but it doe
text is in this list. text is in this list.
.. note:: .. note::
A keyword cannot contain spaces. The angle brackets are added by default, and when used in the A keyword cannot contain 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 aren't text are a part of the keyword to be replaced. This is to ensure that parts of the text aren't
unintentionally replaced by the content of the list. unintentionally replaced by the content of the list.
@@ -130,16 +130,17 @@ An automatic backup system is built into novelWriter. In order to use it, a back
the backup files are to be stored must be provided in **Preferences**. The path defaults to a the backup files are to be stored must be provided in **Preferences**. The path defaults to a
folder named "Backups" in your home directory. folder named "Backups" in your home directory.
Backups can be run automatically when a project is closed, which also implies it is run when the Backups can run automatically when a project is closed, which also implies it is run when the
application itself is closed. Backups are date stamped zip files of the project files in the application itself is closed. Backups are date stamped zip files of the project files in the
project folder (files not strictly a part of the project are ignored). The zip archives are stored project folder (files not strictly a part of the project are ignored). The zip archives are stored
in a subfolder of the backup path. The subfolder will have the same name as the **Project Name** as in a subfolder of the backup path. The subfolder will have the same name as the **Project Name**
defined in :ref:`docs_ui_projects_settings`. defined in :ref:`docs_ui_projects_settings`.
The backup feature, when configured, can also be run manually from the **Tools** menu. It is also The backup feature, when configured, can also be run manually from the **Tools** menu. It is also
possible to disable automated backups for a given project in **Project Settings**. possible to disable automated backups for a given project in **Project Settings**.
.. note:: .. note::
For the backup to be able to run, the **Project Name** must be set in **Project Settings**. This For the backup to be able to run, the **Project Name** must be set in **Project Settings**. This
value is used to generate the name and path of the backups. Without it, the backup will not run value is used to generate the name and path of the backups. Without it, the backup will not run
at all, but it will produce a warning message. at all, but it will produce a warning message.
@@ -25,7 +25,7 @@ headings will be split into new documents.
You are given the option to create a folder for these new documents, and whether or not to create a You are given the option to create a folder for these new documents, and whether or not to create a
hierarchy of documents. That is, put sections under scenes, and scenes under chapters. hierarchy of documents. That is, put sections under scenes, and scenes under chapters.
The source document **is not** deleted in the process, but you have the option to let the tool move The source document *is not* deleted in the process, but you have the option to let the tool move
the source document to the **Trash** folder. the source document to the **Trash** folder.
@@ -41,8 +41,8 @@ either **Merge Child Items into Self** and **Merge Child Items into New**. The f
pull all content of child items and merge them into the parent document, while the second option pull all content of child items and merge them into the parent document, while the second option
will create a new document in the process. will create a new document in the process.
When merging documents in a folder, you only have the latter process is possible, so only the When merging documents in a folder, only the latter option is possible, so only the choice
choice **Merge Documents in Folder** is available. **Merge Documents in Folder** is available.
In either case, the **Merge Documents** dialog will let you exclude documents you don't want to In either case, the **Merge Documents** dialog will let you exclude documents you don't want to
include, and it also lets you reorder them if you wish. include, and it also lets you reorder them if you wish.
+7 -6
View File
@@ -7,7 +7,7 @@ Writing Statistics
When you work on a project, a log file records when you opened it, when you closed it, and the 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, provided that the total word counts of your novel documents and notes at the end of the session, provided that the
session lasted either more than 5 minutes, or that the total word count changed. For more details session lasted either more than 5 minutes, or that the total word count changed. For more details
about the log file, see :ref:`docs_technical_storage`. about the log file itself, see :ref:`docs_technical_storage`.
A tool to view the content of the log file is available in the **Tools** menu under **Writing A tool to view the content of the log file is available in the **Tools** menu under **Writing
Statistics**. You can also launch it by pressing :kbd:`F6`, or find it on the sidebar. Statistics**. You can also launch it by pressing :kbd:`F6`, or find it on the sidebar.
@@ -16,12 +16,13 @@ The tool will show a list of all your sessions, and a set of filters to apply to
also export the filtered data to a JSON file or to a CSV file that can be opened by a spreadsheet also export the filtered data to a JSON file or to a CSV file that can be opened by a spreadsheet
application like for instance Libre Office Calc or Excel. application like for instance Libre Office Calc or Excel.
.. versionadded:: 1.2
As of version 1.2, the log file also stores how much of the session time was spent idle. The Idle Time
definition of idle here is that the novelWriter main window loses focus, or the user hasn't made =========
any changes to the currently open document in five minutes. The number of minutes can be altered
in **Preferences**. The log file stores how much of the session time was spent idle. The definition of idle here is
that the novelWriter main window loses focus, or the user hasn't made any changes to the currently
open document in five minutes. You can change the number of minutes in **Preferences**.
Session Timer Session Timer