Updated documentation
This commit is contained in:
@@ -11,8 +11,9 @@ This will open the document editor, which uses a simplified markdown format, des
|
||||
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.
|
||||
|
||||
References to tags can also 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`.
|
||||
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.
|
||||
|
||||
.. note::
|
||||
@@ -50,10 +51,42 @@ A non-breaking space is inserted with :kbd:`Shift-Space`.
|
||||
|
||||
Both hard line breaks and non-breaking spaces are highlighted by the syntax highlighter as an 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 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.
|
||||
|
||||
.. note::
|
||||
The "Title" columns cannot be disabled or moved.
|
||||
|
||||
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`.
|
||||
|
||||
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,
|
||||
|
||||
Synopsis Feature
|
||||
================
|
||||
|
||||
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.
|
||||
|
||||
.. 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.
|
||||
|
||||
Keyboard Shortcuts
|
||||
==================
|
||||
|
||||
All features are available as keyboard shortcuts.
|
||||
Most features are available as keyboard shortcuts.
|
||||
These are as following:
|
||||
|
||||
.. csv-table:: Keyboard Shortcuts
|
||||
@@ -92,6 +125,7 @@ These are as following:
|
||||
":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-,`", "Change project settings."
|
||||
@@ -115,6 +149,7 @@ These are as following:
|
||||
":kbd:`F7`", "Re-run spell checker."
|
||||
":kbd:`F8`", "Activate Zen Mode, hiding project tree and view panel."
|
||||
":kbd:`F9`", "Re-build project indices."
|
||||
":kbd:`F10`", "Re-build project outline."
|
||||
":kbd:`F11`", "Activate full screen mode."
|
||||
":kbd:`Shift-Enter`", "Insert a hard line break at the cursor position."
|
||||
":kbd:`Shift-F3`", "Find previous occurrence of word in current document. (Same as :kbd:`Ctrl-Shift-G`"
|
||||
|
||||
Reference in New Issue
Block a user