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

Clean up the "User Interface" section

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/user_interface/main_window.rst
+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 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
also available in the main menu under **Format**, so you don't have to look up formatting codes
every time you need them. For reference, a list of all shortcuts can be found in the
Most formatting features supported are also available through keyboard shortcuts, as well as
available in the main menu under **Format**, so you don't have to look up formatting codes every
time you need them. For reference, a list of all shortcuts can be found in the
: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
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.
When the application is in **Project Tree View** mode, the work area of the main window is split in
two, or optionally three, panels. The left-most panel contains the project tree and all the
documents in your project. The second panel is the document editor.
When **Project Tree View** in the sidebar is selected, the work area is split in two, or
optionally three, panels. The left-most panel contains the project tree and all the documents in
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
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
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
-----------
The project tree allows drag & drop to allow you to reorder your documents and folders. Moving a
document in the project tree will affect the text's position when you assemble your manuscript in
the **Manuscript Build** tool.
The project tree allows drag & drop so you to reorder your documents and folders. Moving a document
in the project tree will affect the text's position when you assemble your manuscript in the
**Manuscript Build** tool.
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
@@ -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.
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.
.. tip::
@@ -93,10 +88,10 @@ Novel View 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
your novel structure for a specific Novel root folder. Instead of showing individual
documents, the tree now shows all headings of your novel text. This includes multiple headings
within the same document.
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** type root folder. Instead of showing individual
documents, the tree now shows all headings of your text. This includes multiple headings within the
same document.
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
@@ -122,9 +117,9 @@ meta data collected for that heading.
.. note::
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
in the project tree. However, you can add new headings to existing documents, or change
references, which will be updated in this view when the document is saved.
imply restructuring the content of the documents themselves. Any such editing must be done in
the project tree. However, you can add new headings to existing documents, or change references,
which will be updated in this view when the document is saved.
.. _docs_ui_main_outline:
@@ -136,14 +131,14 @@ 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
a large table that shows the entire novel structure with all the tags and references listed. You
can select which novel folder to display from the dropdown menu. You can optionally choose to show
a combination of all novel folders.
When **Novel Outline View** in the sidebar is selected, the tree, editor and viewer are replaced by
a table that shows the entire novel structure with all the tags and references listed. You can
select which novel folder to display from the dropdown menu. You can optionally choose to show a
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
: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.
.. note::
@@ -180,7 +175,7 @@ whichever of the two is visible. If one of them already has focus, the key press
between them instead.
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
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.
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.
.. note::