Veronica K. B. Olsen
80 lines
4.0 KiB
Plaintext
80 lines
4.0 KiB
Plaintext
##############
|
|
User Interface
|
|
##############
|
|
|
|
The user interface is kept as simple as possible to avoid distractions.
|
|
The main window contains a tree vew pane with the entire structure of the project, and a small details panel below it to display additional information.
|
|
|
|
Editing a document can be done by either double-clicking on it, or hitting the return key when the item is selected.
|
|
This will open the source editor which uses a simplified markdown format described in the section below.
|
|
|
|
The document can also be viewed as html with all the comments and commands stripped out. To view a document, simply press 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.
|
|
|
|
***************
|
|
Markdown Format
|
|
***************
|
|
|
|
the document editor uses a simplified markdown format.
|
|
That is, it supports basic formatting like bold, italics and underline, as well as four levels of headings.
|
|
The formats are listed below.
|
|
|
|
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 seen in the document viewer.
|
|
The editor also has a minimal set of commands used for setting tags and references between files.
|
|
|
|
* ``# 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 renderred as bold text.
|
|
* ``_text_``:The text is renderred as italics text.
|
|
* ``__text__``: The text is renderred as underlined text.
|
|
* ``% text...``: A comment. The text is not exported, seen in viewer, or counted towards word counts.
|
|
* ``@keyword: value``: A keyword argument followed by a value, or a comma separated list of values.
|
|
|
|
******************
|
|
Keyboard Shortcuts
|
|
******************
|
|
|
|
All features are available as keyboard shortcuts.
|
|
These are as following:
|
|
|
|
* ``Ctrl+Shift+O``: Open a project.
|
|
* ``Ctrl+Shift+S``: Save the current project.
|
|
* ``Ctrl+Shift+W``: Close the current project.
|
|
* ``Ctrl+Shift+,``: Change project settings.
|
|
* ``Ctrl+Shift+N``: Create new folder.
|
|
* ``Ctrl+E, F2``: If in tree view, edit a document or folder settings.
|
|
* ``Ctrl+Del``: If in tree view, move a document to trash, or delete a folder.
|
|
* ``Ctrl+Q``: Exit novelWriter.
|
|
* ``Ctrl+N``: Create new document.
|
|
* ``Ctrl+O``: Open selected document.
|
|
* ``Return``: If in tree view, open a document for editing.
|
|
* ``Ctrl+S``: Save the current document in the editor.
|
|
* ``Ctrl+W``: Close the current document in the editor.
|
|
* ``Ctrl+R``: If in tree view, open a document for viewing. If in editor pane, open current document for viewing.
|
|
* ``Ctrl+Shift+R``: Close the document view pane.
|
|
* ``Ctrl+Z``: Undo latest changes.
|
|
* ``Ctrl+Y``: Redo latest undo.
|
|
* ``Ctrl+C``: Copy selected text to clipboard.
|
|
* ``Ctrl+X``: Cut selected text to clipboard.
|
|
* ``Ctrl+V``: Paste text from clipboard to cursor position.
|
|
* ``Ctrl+A``: Select all text in document.
|
|
* ``Ctrl+Shift+A``: Select all text in current paragraph.
|
|
* ``Ctrl+1``: Switch focus to tree view pane.
|
|
* ``Ctrl+2``: Switch focus to document editor pane.
|
|
* ``Ctrl+3``: Switch focus to document viewer pane.
|
|
* ``Ctrl+T``: Show project timeline.
|
|
* ``Ctrl+B``: Format selected text, or word under cursor, as bold.
|
|
* ``Ctrl+I``: Format selected text, or word under cursor, as italic.
|
|
* ``Ctrl+U``: Format selected text, or word under cursor, as underline.
|
|
* ``Ctrl+D``: Wrap selected text, or word under cursor, in double quotes.
|
|
* ``Ctrl+Shift+D``: Wrap selected text, or word under cursor, in single quotes.
|
|
* ``Ctrl+Shift+Up``: Move item one step up in the tree view.
|
|
* ``Ctrl+Shift+Down``: Move item one step down in the tree view.
|
|
* ``Ctrl+F7``: Toggle spell checking.
|
|
* ``F7``: Re-run spell checker.
|
|
* ``Ctrl+.``: Correct word under cursor.
|
|
* ``F9``: Re-build project indices.
|
|
* ``F1``: Open documentation.
|