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

Added custom css and rewrote the interfaces docs file

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2020-08-03 22:46:43 +02:00
parent c6c47866d1
commit 9e2fe92c83
6 changed files with 340 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
-1
View File
@@ -8,7 +8,6 @@
# Documentation
/docs/build/
/docs/source/_*
# Python Temp
__pycache__
docs/source/_static/css/custom.css
+23
View File
@@ -0,0 +1,23 @@
/*
* Custom CSS Rules for Sphinx RTD Theme
*/
.kbd {
background-color: #eeeeee;
border: 1px solid #b4b4b4;
border-radius: 3px;
color: #333333;
display: inline-block;
font-size: 0.85em;
font-weight: 400;
line-height: 1;
padding: 2px 4px;
margin-left: 1px;
margin-right: 1px;
white-space: nowrap;
}
.tight-table td {
white-space: normal !important;
vertical-align: text-top;
}
docs/source/conf.py
+9 -12
View File
@@ -69,23 +69,20 @@ pygments_style = None
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "sphinx_rtd_theme"
html_theme_options = {
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 3,
'includehidden': True,
'titles_only': False
"collapse_navigation": True,
"sticky_navigation": True,
"navigation_depth": 3,
"includehidden": True,
"titles_only": False
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ["_static"]
html_static_path = []
html_static_path = ["_static"]
html_css_files = [
"css/custom.css",
]
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
docs/source/interface.rst
+294 -144
View File
@@ -1,204 +1,354 @@
.. _a_ui:
***************
User Interface
***************
The user interface is kept as simple as possible to avoid distractions when writing.
The main window contains a tree view pane with the entire structure of the project, and a small
details panel below it to display additional information about the currently selected item.
.. _a_ui_tree:
Edit View
=========
The Project Tree
================
Editing a document can be done by either double-clicking on it, or hitting the return key when a file is selected.
This will open the document editor, which uses a simplified markdown format, described in the section below.
The main window contains a Project Tree in the left-most panel. It shows the entire structure of the
project. It has four columns:
The document currently being edited can also be viewed in parallel in a right hand side view pane.
To view a document, simply press :kbd:`Ctrl-R`, or select a file and go to :menuselection:`Document --> View Document` in the menu.
The document viewed does not need to be the same document currently being edited.
If you are viewing the same document as the one you're editing, pressing :kbd:`Ctrl-R` again will update the document with your last changes.
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`.
References to tags can be opened in the view pane from the document editor by moving the cursor to a reference to a tag and hitting :kbd:`Ctrl-Enter`.
In the view panel, the references become clickable links, and the "Referenced By" panel at the bottom will show links to all documents referring back to it.
Words
The second column shows the word count of the file, or the sum of words in the child items if it
is a folder. If the counts seem incorrect, they can be updated by rebuilding the Project Index
from the menu, or by pressing :kbd:`F9`.
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
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
class of the item, that is ``N`` for **Novel**, ``C`` for **Character**, etc (see
:ref:`a_struct_tags`. The second character indicates the file layout type (see
:ref:`a_proj_roots`).
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.
.. _a_ui_edit:
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.
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.
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.
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.
.. note::
The "Referenced By" 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 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`.
Both the document editor and the viewer will show the label of the document as set in the Project Tree.
Optionally, the full project path to the file can be shown.
This can be set the Preferences.
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.
.. _a_ui_md:
Markdown Format
===============
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.
It is commonly recommended style to differentiate between strong emphasis and emphasis by using ``**`` 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.
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.
In addition to these standard markdown features, the editor also allows for comments, that is text that is ignored by the word counter and not exported or, optionally, hidden in the document viewer.
If the first word of a comment is "Synopsis:" (with the colon), the comment is treated specially, and will show up in the Outline View.
The editor also has a minimal set of keywords used for setting tags and references between files.
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.
.. csv-table:: Formatting Syntax
:header: "Format", "Description"
:widths: 15, 50
"``# Title``", "Heading level one. The space after the # is mandatory."
"``## Title``", "Heading level two. The space after the # is mandatory."
"``### Title``", "Heading level three. The space after the # is mandatory."
"``#### Title``", "Heading level four. The space after the # is mandatory."
"``_text_``", "The text is rendered as emphasised text (italicised)."
"``**text**``", "The text is rendered as strongly emphasised text (bold)."
"``~~text~~``", "Strikethrough text."
"``% text...``", "A comment. The text is not exported by default, seen in viewer, or counted towards word counts."
"``% Synopsis: text...``", "A synopsis comment. Shows up in the Synopsis column of the Outline View, but is otherwise treated as a comment."
"``@keyword: value``", "A keyword argument followed by a value, or a comma separated list of values."
.. _a_ui_md_head:
Some additional rules:
Headings
--------
1. The emphasis and strikethrough formatting tags do not allow spaces between the words and the tag itself.
That is, ``**text**`` is valid, ``**text **`` is not.
2. More generally, the delimiters must be on the outer edge of words.
That is, ``some **text in bold** here`` is valid, ``some** text in bold** here`` is not.
Four levels of headings are allowed. For files of type "Note", they are free to be used as you see
fit, but for all other file layouts used for the novel text itself, they indicate the structural
level of the novel. See :ref:`a_struct_heads` for more details.
``# Title``
Heading level one. The space after the # is mandatory. If the file is a novel file, the header
level indicates the start of a new partition.
``## Title``
Heading level two. The space after the # is mandatory. If the file is a novel file, the header
level indicates the start of a new chapter.
``### Title``
Heading level three. The space after the # is mandatory. If the file is a novel file, the header
level indicates the start of a new scene.
``#### Title``
Heading level four. The space after the # is mandatory. If the file is a novel file, the header
level indicates the start of a new section.
.. _a_ui_md_emph:
Text Emphasis
-------------
In markdown it is often recommended to differentiate between strong emphasis and emphasis by using
``**`` 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.
``_text_``
The text is rendered as emphasised text (italicised).
``**text**``
The text is rendered as strongly emphasised text (bold).
``~~text~~``
Strikethrough text.
There are also some additional rules:
1. The emphasis and strikethrough formatting tags do not allow spaces between the words and the tag
itself. That is, ``**text**`` is valid, ``**text **`` is not.
2. More generally, the delimiters must be on the outer edge of words. That is, ``some **text in
bold** here`` is valid, ``some** text in bold** here`` is not.
3. If using both ``**`` and ``_`` to wrap the same text, the underscore must be the inner wrapper.
This is due to the underscore also being a valid word character, so if they are on the outside, they violate rule 2.
This is due to the underscore also being a valid word character, so if they are on the outside,
they violate rule 2.
The editor and viewer also supports markdown standard hard line breaks, and preserves non-breaking spaces.
A hard line break is achieved by leaving two or more spaces at the end of the line.
Alternatively, the user can press :kbd:`Ctrl-K, Return` to insert this.
A non-breaking space is inserted with :kbd:`Ctrl-K, Space`.
Thin spaces are also supported, and can be inserted with :kbd:`Ctrl-K, Shift-Space`, and the non-breaking version of it with :kbd:`Ctrl-K, Ctrl-Space`.
.. _a_ui_md_comm:
Both hard line breaks and non-breaking spaces are highlighted by the syntax highlighter as an alternate coloured background, depending on the selected theme.
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,
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`.
``% text...``
A comment. The text is not exported by default (this can be overridden), seen in the Viewer, or
counted towards word counts.
``% Synopsis: text...``
A synopsis comment. It is generally treated in the same way as regular comments, except that it
is captured by the indexing algorithm and displayed in the :ref:`a_ui_outline`. It can also be
filtered separately when exporting the project to for instance generate an outline document of
the whole project.
.. _a_ui_md_tags:
Tags and References
-------------------
The Editor also has a minimal set of keywords used for setting tags and references between files.
``@keyword: value``
A keyword argument followed by a value, or a comma separated list of values.
The available tag and reference keywords are listed in the :ref:`a_struct_tags` section.
.. _a_ui_md_add:
Additional Markdown and Non-Standard Features
---------------------------------------------
The Editor and Viewer also supports markdown standard hard line breaks, and preserves non-breaking
spaces if running with Qt 5.9 or higher.
* A hard line break is achieved by leaving two or more spaces at the end of the line. Alternatively,
the user can press :kbd:`Ctrl`:kbd:`K`, :kbd:`Return` to insert this.
* A non-breaking space is inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Space`.
* 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
in :ref:`a_ui_shortcuts_ins`.
Both hard line breaks and non-breaking spaces are highlighted by the syntax highlighter as an
alternate coloured background, depending on the selected theme.
.. _a_ui_outline:
Project Outline View
====================
The Project Outline View is available as the second tab on the right hand side of the main window marked "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.
Various meta data and information extracted from tags can be displayed in columns in the Outline View.
To turn on or off specific columns, right click the header and select the columns you want to show.
The order of the columns can be rearranged by dragging them to a different position.
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.
.. note::
The "Title" columns cannot be disabled or moved.
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.
The information viewed in teh 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 pressing :kbd:`F9`.
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.
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.
You may want to disable this feature if your project is very large,
.. note::
The Title column cannot be disabled or moved.
Synopsis Feature
================
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
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
very large,
.. _a_ui_outline_synopsis:
Synopsis Column
---------------
The "Synopsis" column of the Outline View takes its information from a specially formatted comment.
In order to flag a comment as a Synopsis, add the word "Synopsis:" as the first word of the comment.
The ":" is required, and "synopsis" is not case sensitive.
If it is correctly formatted, the syntax highlighter will indicate this by altering the colour of the word.
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.
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.
.. _a_ui_shortcuts:
Keyboard Shortcuts
==================
Most features are available as keyboard shortcuts.
These are as following:
Most features are available as keyboard shortcuts. These are as following:
.. csv-table:: Keyboard Shortcuts
:header: "Shortcut", "Description"
:widths: 15, 50
:widths: 30, 70
:class: "tight-table"
":kbd:`Alt-1`", "Switch focus to tree view pane."
":kbd:`Alt-2`", "Switch focus to document editor pane."
":kbd:`Alt-3`", "Switch focus to document viewer pane."
":kbd:`Ctrl-.`", "Correct word under cursor."
":kbd:`Ctrl-,`", "Open the Preferences dialog."
":kbd:`Ctrl-/`", "Change block format to comment."
":kbd:`Ctrl--`", "Strikethrough selected text, or word under cursor."
":kbd:`Ctrl-0`", "Remove block formatting for block under cursor."
":kbd:`Ctrl-1`", "Change block format to header level 1."
":kbd:`Ctrl-2`", "Change block format to header level 2."
":kbd:`Ctrl-3`", "Change block format to header level 3."
":kbd:`Ctrl-4`", "Change block format to header level 4."
":kbd:`Ctrl-A`", "Select all text in document."
":kbd:`Ctrl-B`", "Format selected text, or word under cursor, with strong emphasis (bold)."
":kbd:`Ctrl-C`", "Copy selected text to clipboard."
":kbd:`Ctrl-D`", "Wrap selected text, or word under cursor, in double quotes."
":kbd:`Ctrl-E`", "If in tree view, edit a document or folder settings. (Same as :kbd:`F2`)"
":kbd:`Ctrl-F`", "Open the search bar and search for selected word, if any is selected."
":kbd:`Ctrl-G`", "Find next occurrence of word in current document. (Same as :kbd:`F3`)"
":kbd:`Ctrl-H`", "Open the search and replace bar and search for selected word, if any is selected. (On Mac, this is :kbd:`Cmd-=`)"
":kbd:`Ctrl-I`", "Format selected text, or word under cursor, with emphasis (italic)."
":kbd:`Ctrl-N`", "Create new document."
":kbd:`Ctrl-O`", "Open selected document."
":kbd:`Ctrl-Q`", "Exit novelWriter."
":kbd:`Ctrl-R`", "If in tree view, open a document for viewing. If editor pane has focus, open current document for viewing."
":kbd:`Ctrl-S`", "Save the current document in the editor."
":kbd:`Ctrl-V`", "Paste text from clipboard to cursor position."
":kbd:`Ctrl-W`", "Close the current document in the editor."
":kbd:`Ctrl-X`", "Cut selected text to clipboard."
":kbd:`Ctrl-Y`", "Redo latest undo."
":kbd:`Ctrl-Z`", "Undo latest changes."
":kbd:`Ctrl-F7`", "Toggle spell checking."
":kbd:`Ctrl-F10`", "Toggle automatic updating of project outline."
":kbd:`Ctrl-Del`", "If in tree view, move a document to trash, or delete a folder."
":kbd:`Ctrl-Enter`", "Open the tag or reference under the cursor in the view panel."
":kbd:`Ctrl-Shift-,`", "Open the Project Settings dialog."
":kbd:`Ctrl-Shift-/`", "Remove block formatting for block under cursor."
":kbd:`Ctrl-Shift-1`", "Replace occurrence of word in current document, and search for next occurrence."
":kbd:`Ctrl-Shift-A`", "Select all text in current paragraph."
":kbd:`Ctrl-Shift-B`", "Format selected text, or word under cursor, with very strong emphasis (bold and italic)."
":kbd:`Ctrl-Shift-D`", "Wrap selected text, or word under cursor, in single quotes."
":kbd:`Ctrl-Shift-G`", "Find previous occurrence of word in current document. (Same as :kbd:`Shift-F3`"
":kbd:`Ctrl-Shift-I`", "Import text to the current document from a text file."
":kbd:`Ctrl-Shift-N`", "Create new folder."
":kbd:`Ctrl-Shift-O`", "Open a project."
":kbd:`Ctrl-Shift-R`", "Close the document view pane."
":kbd:`Ctrl-Shift-S`", "Save the current project."
":kbd:`Ctrl-Shift-W`", "Close the current project."
":kbd:`Ctrl-Shift-Up`", "Move item one step up in the tree view."
":kbd:`Ctrl-Shift-Down`", "Move item one step down in the tree view."
":kbd:`F1`", "Open documentation. This just tries to send the documentation URL ti your browser."
":kbd:`F2`", "If in tree view, edit a document or folder settings. (Same as :kbd:`Ctrl-E`)"
":kbd:`F3`", "Find next occurrence of word in current document. (Same as :kbd:`Ctrl-G`)"
":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:`Ctrl`:kbd:`.`", "Open menu to correct word under cursor."
":kbd:`Ctrl`:kbd:`,`", "Open the 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."
":kbd:`Ctrl`:kbd:`1`", "Change block format to header level 1."
":kbd:`Ctrl`:kbd:`2`", "Change block format to header level 2."
":kbd:`Ctrl`:kbd:`3`", "Change block format to header level 3."
":kbd:`Ctrl`:kbd:`4`", "Change block format to header level 4."
":kbd:`Ctrl`:kbd:`A`", "Select all text in the document."
":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:`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:`=`)"
":kbd:`Ctrl`:kbd:`I`", "Format selected text, or word under cursor, with emphasis (italic)."
":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:`V`", "Paste text from clipboard to cursor position."
":kbd:`Ctrl`:kbd:`W`", "Close the current document in the 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:`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:`/`", "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."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`D`", "Wrap selected text, or word under cursor, in single quotes."
":kbd:`Ctrl`:kbd:`Shift`:kbd:`G`", "Find previous occurrence of search word in current document. (Same as :kbd:`Shift`:kbd:`F3`)"
":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:`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:`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:`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 Focus Mode, hiding Project Tree and view panel."
":kbd:`F9`", "Re-build Project Index."
":kbd:`F10`", "Re-build Project Outline."
":kbd:`F11`", "Activate full screen mode."
":kbd:`Shift-F3`", "Find previous occurrence of word in current document. (Same as :kbd:`Ctrl-Shift-G`"
":kbd:`Enter`", "If in tree view, open a document for editing."
":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."
.. note::
On macOS, replace :kbd:`Ctrl` with :kbd:`Cmd`.
A set of insert features are also available through shortcuts, but they require a double combination of shortcuts.
The insert feature is activated with :kbd:`Ctrl-K`, followed by a key for the inserted character or punctuation.
.. _a_ui_shortcuts_ins:
Insert Shortcuts
----------------
A set of insert features are also available through shortcuts, but they require a double combination
of key sequences. The insert feature is activated with :kbd:`Ctrl-K`, followed by a key or
combination for the inserted character or punctuation.
.. csv-table:: Keyboard Shortcuts
:header: "Shortcut", "Description"
:widths: 30, 50
:widths: 40, 60
:class: "tight-table"
":kbd:`Ctrl-K, -`", "Insert a short dash (en dash)."
":kbd:`Ctrl-K, _`", "Insert a long dash (em dash)."
":kbd:`Ctrl-K, .`", "Insert ellipsis."
":kbd:`Ctrl-K, 1`", "Insert left single quote."
":kbd:`Ctrl-K, 2`", "Insert right single quote."
":kbd:`Ctrl-K, 3`", "Insert left double quote."
":kbd:`Ctrl-K, 4`", "Insert right double quote."
":kbd:`Ctrl-K, Return`", "Insert a hard line break."
":kbd:`Ctrl-K, Space`", "Insert a non-breaking space."
":kbd:`Ctrl-K, Shift-Space`", "Insert a thin space."
":kbd:`Ctrl-K, Ctrl-Space`", "Insert a thin non-breaking space."
":kbd:`Ctrl`:kbd:`K`, :kbd:`-`", "Insert a short dash (en dash)."
":kbd:`Ctrl`:kbd:`K`, :kbd:`_`", "Insert a long dash (em dash)."
":kbd:`Ctrl`:kbd:`K`, :kbd:`.`", "Insert ellipsis."
":kbd:`Ctrl`:kbd:`K`, :kbd:`1`", "Insert left single quote."
":kbd:`Ctrl`:kbd:`K`, :kbd:`2`", "Insert right single quote."
":kbd:`Ctrl`:kbd:`K`, :kbd:`3`", "Insert left double quote."
":kbd:`Ctrl`:kbd:`K`, :kbd:`4`", "Insert right double quote."
":kbd:`Ctrl`:kbd:`K`, :kbd:`Return`", "Insert a hard line break."
":kbd:`Ctrl`:kbd:`K`, :kbd:`Space`", "Insert a non-breaking space."
":kbd:`Ctrl`:kbd:`K`, :kbd:`Shift`:kbd:`Space`", "Insert a thin space."
":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`", "Insert a thin non-breaking space."
docs/source/projects.rst
+4
View File
@@ -1,3 +1,5 @@
.. _a_proj:
**************
Novel Projects
**************
@@ -12,6 +14,8 @@ A project can be removed from this list by selecting it and pressing the :kbd:`D
The project specific settings are available in :menuselection:`Project --> Project Settings`.
See further details below.
.. _a_proj_roots:
Project Roots
=============
docs/source/structure.rst
+6
View File
@@ -1,3 +1,5 @@
.. _a_struct:
*****************
Project Structure
*****************
@@ -8,6 +10,8 @@ This section covers the structure of a novel project.
This section concerns files under the Novel type root folder only.
There are some restrictions and features that only applies to these type of files.
.. _a_struct_heads:
Importance of Headings
======================
@@ -26,6 +30,8 @@ The different header levels are interpreted as specific section types of the nov
* ``### Header3``: Header level 3 signifies a scene level partition.
* ``#### Header4``: Header level 4 signifies a sub-scene level partition (section).
.. _a_struct_tags:
Tag References
==============