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

Made a new pass of all the previously updated documentation files

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2020-08-06 22:08:36 +02:00
parent cb8e0231d7
commit 21eebbb88f
10 changed files with 262 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/interface.rst
+85 -81
View File
@@ -11,24 +11,24 @@ The user interface is kept as simple as possible to avoid distractions when writ
The Project Tree
================
The main window contains a Project Tree in the left-most panel. It shows the entire structure of the
The main window contains a project tree in the left-most panel. It shows the entire structure of the
project. It has four columns:
Label
:guilabel:`Label`
The first column shows the item icon and its label. The labels can be edited from the menu, or by
pressing :kbd:`F2` or :kbd:`Ctrl`:kbd:`E`.
Words
: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
is a folder. If the counts seem incorrect, they can be updated by rebuilding the project index
from the menu, or by pressing :kbd:`F9`.
Inc
: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.
Flags
: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. They can be changed in Project Settings. The first character after the icon indicates the
@@ -36,7 +36,7 @@ Flags
:ref:`a_struct_tags`. The second character indicates the file layout type (see
:ref:`a_proj_roots`).
Below the Project Tree is a small details panel showing the full information of the currently
Below the project tree is a small details panel showing the full information of the currently
selected item. This panel also includes the latest paragraph and character counts.
@@ -45,37 +45,38 @@ selected item. This panel also includes the latest paragraph and character count
Editing and Viewing Documents
=============================
To edit a document, double-click the file in the tree view, or press the :kbd:`Return` key while
having it selected. This will open the document in the 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 Focus Mode) and a close button in the top-right corner.
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 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:`Focus 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 view panel or
the Viewer. To view a document, press :kbd:`Ctrl`:kbd:`R`, or select :menuselection:`View Document`
in the menu. The document viewed does not have to be the same document currently being edited. If
you *are* viewing the same document though, pressing :kbd:`Ctrl`:kbd:`R` again will update the
document with your latest changes. You can also press the little reload button in the top-right
corner of the view panel next to the close button.
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 menu. The
document viewed does not have to be the same document currently being edited. If you *are* viewing
the same document though, pressing :kbd:`Ctrl`:kbd:`R` again will update the document with your
latest changes. You can also press the little reload button in the top-right corner of the view
panel next to the close button.
Both the Editor and the Viewer will show the label of the document in the document 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 Preferences dialog. 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.
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.
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.
Clicking them will replace the content of the Viewer with the content of the document the reference
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.
Clicking them will replace the content of the viewer with the content of the document the reference
points to.
At the bottom of the Viewer's panel there is a References panel (click the icon if it is hidden)
that will show links to all documents referring back to it. The Sticky button will freeze the
content of the panel to the current document, even if you navigate to another document. This is
convenient if you want to quickly look through all documents in the list.
At the bottom of the viewer's panel there is a :guilabel:`References` panel (click the icon if it is
hidden) that will show links to all documents referring back to it. The :guilabel:`Sticky` button
will freeze the content of the panel to the current document, even if you navigate to another
document. This is convenient if you want to quickly look through all documents in the list.
.. note::
The References panel relies on an up-to-date index of the project. If anything is missing, or
seems wrong, the index can always be rebuilt from :menuselection:`Tools --> Rebuild Index` or by
pressing :kbd:`F9`.
The :guilabel:`References` panel relies on an up-to-date index of the project. If anything is
missing, or seems wrong, the index can always be rebuilt from :guilabel:`Tools` >
:guilabel:`Rebuild Index` or by pressing :kbd:`F9`.
.. _a_ui_md:
@@ -83,8 +84,9 @@ convenient if you want to quickly look through all documents in the list.
Markdown Format
===============
The Editor uses a simplified markdown format. That is, it supports basic formatting like emphasis
(italic), strong emphasis (bold) and strikethrough text, as well as four levels of headings.
The document editor uses a simplified markdown format. That is, it supports basic formatting like
emphasis (italic), strong emphasis (bold) and strikethrough text, as well as four levels of
headings.
Some non-standard markdown features have been added. For instance, novelWriter allows for comments,
a synopsis tag, and a set of keyword/value sets used for tags and references.
@@ -125,7 +127,7 @@ In markdown it is often recommended to differentiate between strong emphasis and
``**`` for strong emphasis and ``_`` for emphasis, although markdown generally supports also ``__``
for strong emphasis and ``*`` fdr emphasis. However, since the differentiation makes the
highlighting and conversion significantly simpler and faster, in novelWriter this is a rule, not
just a recommendation.
just a recommendation. The following is therefore the only supported formatting syntax:
``_text_``
The text is rendered as emphasised text (italicised).
@@ -152,8 +154,8 @@ There are also some additional rules:
Comments and Synopsis
---------------------
In addition to these standard markdown features, the 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,
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`.
@@ -173,7 +175,9 @@ the comment is treated specially, and will show up in the :ref:`a_ui_outline`.
Tags and References
-------------------
The Editor also has a minimal set of keywords used for setting tags and references between files.
The document editor supports a minimal set of keywords used for setting tags and 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.
``@keyword: value``
A keyword argument followed by a value, or a comma separated list of values.
@@ -195,7 +199,7 @@ spaces if running with Qt 5.9 or higher.
* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Shift`:kbd:`Space`.
* Non-breaking thin space can be inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`.
These are all insert features, and the :menuselection:`Insert` menu has more. They are also listed
These are all insert features, and the :guilabel:`Insert` menu has more. They are also listed
in :ref:`a_ui_shortcuts_ins`.
Both hard line breaks and non-breaking spaces are highlighted by the syntax highlighter as an
@@ -207,29 +211,29 @@ alternate coloured background, depending on the selected theme.
Project Outline View
====================
The Project Outline View is available as the second tab on the right hand side of the main window
labelled "Outline". The Outline View 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.
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.
.. 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. See the :ref:`a_struct` page for more details.
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. 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
View. A default set is visible, but you can turn on or off more columns by right clicking the header
and selecting the columns you want to show. The order of the columns can also be rearranged by
dragging them to a different position.
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
the header and selecting the columns you want to show. The order of the columns can also be
rearranged by dragging them to a different position.
.. note::
The Title column cannot be disabled or moved.
The :guilabel:`Title` column cannot be disabled or moved.
The information viewed in the Outline View is based on the Project Index. While novelWriter does its
best to keep the index up to date when content changes, you can always rebuild it manually by
The information viewed in the outline is based on the project's main index. While novelWriter does
its best to keep the index up to date when content changes, you can always rebuild it manually by
pressing :kbd:`F9` if something isn't right.
The Outline View itself can be regenerated by pressing :kbd:`F10`. You can also enable automatic
updating in the :menuselection:`Tools` menu, which will trigger an update whenever the index is
updated and the Outline tab is activated. You may want to disable this feature if your project is
The outline view itself can be regenerated by pressing :kbd:`F10`. You can also enable automatic
updating in the :guilabel:`Tools` menu, which will trigger an update whenever the index is updated
and the :guilabel:`Outline` tab is active. You may want to disable this feature if your project is
very large,
@@ -238,15 +242,15 @@ very large,
Synopsis Column
---------------
The "Synopsis" column of the Outline View takes its information from a specially formatted comment.
See :ref:`a_ui_md_comm`. In order to flag a comment as a synopsis, add the word ``Synopsis:`` as the
first word of the comment. The ``:`` is required, and 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.
The :guilabel:`Synopsis` column of the outline view takes its information from a specially formatted
comment. See :ref:`a_ui_md_comm`. In order to flag a comment as a synopsis, add the word
``Synopsis:`` as the first word of the comment. The ``:`` is required, and 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.
.. note::
Only one comment can be flagged as a synopsis comment for each heading. If multiple comments are
flagged as a synopsis, the last one will be used.
flagged as a synopsis comment, the last one will be used.
.. _a_ui_shortcuts:
@@ -261,11 +265,11 @@ Most features are available as keyboard shortcuts. These are as following:
:widths: 30, 70
:class: "tight-table"
":kbd:`Alt`:kbd:`1`", "Switch focus to the Project Tree."
":kbd:`Alt`:kbd:`2`", "Switch focus to Editor."
":kbd:`Alt`:kbd:`3`", "Switch focus to Viewer."
":kbd:`Alt`:kbd:`1`", "Switch focus to the project tree."
":kbd:`Alt`:kbd:`2`", "Switch focus to document editor."
":kbd:`Alt`:kbd:`3`", "Switch focus to document viewer."
":kbd:`Ctrl`:kbd:`.`", "Open menu to correct word under cursor."
":kbd:`Ctrl`:kbd:`,`", "Open the Preferences dialog."
":kbd:`Ctrl`:kbd:`,`", "Open the :guilabel:`Preferences` dialog."
":kbd:`Ctrl`:kbd:`/`", "Change block format to comment."
":kbd:`Ctrl`:kbd:`-`", "Strikethrough selected text, or word under cursor."
":kbd:`Ctrl`:kbd:`0`", "Remove block formatting for block under cursor."
@@ -277,7 +281,7 @@ Most features are available as keyboard shortcuts. These are as following:
":kbd:`Ctrl`:kbd:`B`", "Format selected text, or word under cursor, with strong emphasis (bold)."
":kbd:`Ctrl`:kbd:`C`", "Copy selected text to clipboard."
":kbd:`Ctrl`:kbd:`D`", "Wrap selected text, or word under cursor, in double quotes."
":kbd:`Ctrl`:kbd:`E`", "If in the Project Tree, edit a document or folder settings. (Same as :kbd:`F2`)"
":kbd:`Ctrl`:kbd:`E`", "If in the project tree, edit a document or folder settings. (Same as :kbd:`F2`)"
":kbd:`Ctrl`:kbd:`F`", "Open the search bar and search for the selected word, if any is selected."
":kbd:`Ctrl`:kbd:`G`", "Find next occurrence of search word in current document. (Same as :kbd:`F3`)"
":kbd:`Ctrl`:kbd:`H`", "Open the search and replace bar and search for the selected word, if any is selected. (On Mac, this is :kbd:`Cmd`:kbd:`=`)"
@@ -285,18 +289,18 @@ Most features are available as keyboard shortcuts. These are as following:
":kbd:`Ctrl`:kbd:`N`", "Create new document."
":kbd:`Ctrl`:kbd:`O`", "Open selected document."
":kbd:`Ctrl`:kbd:`Q`", "Exit novelWriter."
":kbd:`Ctrl`:kbd:`R`", "If in the Project Tree, open a document for viewing. If the Editor has focus, open current document for viewing."
":kbd:`Ctrl`:kbd:`S`", "Save the current document in the Editor."
":kbd:`Ctrl`:kbd:`R`", "If in the project tree, open a document for viewing. If the editor has focus, open current document for viewing."
":kbd:`Ctrl`:kbd:`S`", "Save the current document in the document editor."
":kbd:`Ctrl`:kbd:`V`", "Paste text from clipboard to cursor position."
":kbd:`Ctrl`:kbd:`W`", "Close the current document in the Editor."
":kbd:`Ctrl`:kbd:`W`", "Close the current document in the document editor."
":kbd:`Ctrl`:kbd:`X`", "Cut selected text to clipboard."
":kbd:`Ctrl`:kbd:`Y`", "Redo latest undo."
":kbd:`Ctrl`:kbd:`Z`", "Undo latest changes."
":kbd:`Ctrl`:kbd:`F7`", "Toggle spell checking."
":kbd:`Ctrl`:kbd:`F10`", "Toggle automatic updating of Project Outline."
":kbd:`Ctrl`:kbd:`Del`", "If in the Project Tree, move a document to trash, or delete a folder."
":kbd:`Ctrl`:kbd:`F10`", "Toggle automatic updating of project outline."
":kbd:`Ctrl`:kbd:`Del`", "If in the project tree, move a document to trash, or delete a folder."
":kbd:`Ctrl`:kbd:`Enter`", "Open the tag or reference under the cursor in the Viewer."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`,`", "Open the Project Settings dialog."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`,`", "Open the :guilabel:`Project Settings` dialog."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`/`", "Remove block formatting for block under cursor."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`1`", "Replace occurrence of search word in current document, and search for next occurrence."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`A`", "Select all text in current paragraph."
@@ -305,23 +309,23 @@ Most features are available as keyboard shortcuts. These are as following:
":kbd:`Ctrl`:kbd:`Shift`:kbd:`I`", "Import text to the current document from a text file."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`N`", "Create new folder."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`O`", "Open a project."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`R`", "Close the document Viewer."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`R`", "Close the document viewer."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`S`", "Save the current project."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`W`", "Close the current project."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`Up`", "Move item one step up in the Project Tree."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`Down`", "Move item one step down in the Project Tree."
":kbd:`F1`", "Open the documentation. This just tries to send the documentation URL to your browser."
":kbd:`F2`", "If in the Project Tree, edit a document or folder settings. (Same as :kbd:`Ctrl`:kbd:`E`)"
":kbd:`Ctrl`:kbd:`Shift`:kbd:`Up`", "Move item one step up in the project tree."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`Down`", "Move item one step down in the project tree."
":kbd:`F1`", "Open the documentation. This will either open the Qt Assistant, if available, or send you to the documentation website."
":kbd:`F2`", "If in the project tree, edit a document or folder settings. (Same as :kbd:`Ctrl`:kbd:`E`)"
":kbd:`F3`", "Find next occurrence of search word in current document. (Same as :kbd:`Ctrl`:kbd:`G`)"
":kbd:`F5`", "Open the Build Novel Project dialog."
":kbd:`F6`", "Open the Writing Statistics dialog."
":kbd:`F5`", "Open the :guilabel:`Build Novel Project` dialog."
":kbd:`F6`", "Open the :guilabel:`Writing Statistics` dialog."
":kbd:`F7`", "Re-run spell checker."
":kbd:`F8`", "Activate Focus Mode, hiding Project Tree and view panel."
":kbd:`F9`", "Re-build Project Index."
":kbd:`F10`", "Re-build Project Outline."
":kbd:`F8`", "Activate :guilabel:`Focus Mode`, hiding the project tree and document viewer."
":kbd:`F9`", "Re-build the project index."
":kbd:`F10`", "Re-build the project outline."
":kbd:`F11`", "Activate full screen mode."
":kbd:`Shift`:kbd:`F3`", "Find previous occurrence of search word in current document. (Same as :kbd:`Ctrl`:kbd:`Shift`:kbd:`G`)"
":kbd:`Enter`", "If in the Project Tree, open a document for editing."
":kbd:`Enter`", "If in the project tree, open a document for editing."
.. note::
On macOS, replace :kbd:`Ctrl` with :kbd:`Cmd`.