Update docs
This commit is contained in:
Binary file not shown.
|
Before Width: | Height: | Size: 147 KiB After Width: | Height: | Size: 185 KiB |
@@ -12,16 +12,17 @@ text without having to deal with formatting until you generate a draft document
|
|||||||
Instead, you can focus on the writing right from the start.
|
Instead, you can focus on the writing right from the start.
|
||||||
|
|
||||||
Of course, you probably need *some* formatting for your text. At the very least you need emphasis.
|
Of course, you probably need *some* formatting for your text. At the very least you need emphasis.
|
||||||
Most people are familiar with adding emphasis using underscores and asterisks. This formatting
|
Most people are familiar with adding emphasis using ``_underscores_`` and ``**asterisks**``. This
|
||||||
standard comes from Markdown_ and is supported by novelWriter. It also uses Markdown formatting for
|
formatting standard comes from Markdown_ and is supported by novelWriter. It also uses Markdown
|
||||||
defining document headings. If you need more specialised formatting, additional formatting options
|
formatting for defining document headings. If you need more specialised formatting, additional
|
||||||
are available using a shortcode format. See :ref:`a_fmt_shortcodes` for more details.
|
formatting options are available using a shortcode format. See :ref:`a_fmt_shortcodes` for more
|
||||||
|
details.
|
||||||
|
|
||||||
.. admonition:: Limitations
|
.. admonition:: Limitations
|
||||||
|
|
||||||
novelWriter is designed for writing fiction, so the formatting features available are limited to
|
novelWriter is designed for writing fiction, so the formatting features available are limited to
|
||||||
those relevant for this purpose. It is **not** suitable for technical writing, and it is **not**
|
those relevant for this purpose. It is *not* suitable for technical writing, and it is *not* a
|
||||||
a full-featured Markdown editor.
|
full-featured Markdown editor.
|
||||||
|
|
||||||
It is also not intended as a tool for organising research for writing, and therefore lacks
|
It is also not intended as a tool for organising research for writing, and therefore lacks
|
||||||
formatting features you may need for this purpose. The notes feature in novelWriter is mainly
|
formatting features you may need for this purpose. The notes feature in novelWriter is mainly
|
||||||
@@ -32,7 +33,7 @@ instead of a single, large document. The idea is to make it easier to reorganise
|
|||||||
structure without having to cut and paste text between chapters and scenes.
|
structure without having to cut and paste text between chapters and scenes.
|
||||||
|
|
||||||
There are two kinds of documents in your project: :term:`Novel Documents` are documents that are
|
There are two kinds of documents in your project: :term:`Novel Documents` are documents that are
|
||||||
part of your story. The other kind of documents are :term:`Project Notes`. These are intended for
|
part of your story. The other kind of documents are :term:`Project Notes`, which are intended for
|
||||||
your notes about your characters, your world building, and so on.
|
your notes about your characters, your world building, and so on.
|
||||||
|
|
||||||
You can at any point split the individual documents by their headings up into multiple documents,
|
You can at any point split the individual documents by their headings up into multiple documents,
|
||||||
@@ -51,9 +52,12 @@ Below are some key features of novelWriter.
|
|||||||
**Focus on writing**
|
**Focus on writing**
|
||||||
The aim of the user interface is to let you focus on writing instead of spending time formatting
|
The aim of the user interface is to let you focus on writing instead of spending time formatting
|
||||||
text. Formatting is therefore limited to a small set of formatting tags for simple things like
|
text. Formatting is therefore limited to a small set of formatting tags for simple things like
|
||||||
text emphasis and paragraph alignment. When you really want to focus on just writing, you can
|
text emphasis and paragraph alignment. Additional shortcodes are available for special
|
||||||
switch the editor into **Focus Mode** where only the text editor panel itself is visible, and
|
formatting cases.
|
||||||
the project structure view is hidden away.
|
|
||||||
|
When you really want to focus on just writing, you can switch the editor into **Focus Mode**
|
||||||
|
where only the text editor panel itself is visible, and the project structure view is hidden
|
||||||
|
away.
|
||||||
|
|
||||||
**Keep an eye on your notes**
|
**Keep an eye on your notes**
|
||||||
The main window can optionally show a document viewer to the right of the editor. The viewer
|
The main window can optionally show a document viewer to the right of the editor. The viewer
|
||||||
@@ -72,19 +76,22 @@ Below are some key features of novelWriter.
|
|||||||
**Multi-novel project support**
|
**Multi-novel project support**
|
||||||
The main parts of your project is split up into top level special folders called "Root" folders.
|
The main parts of your project is split up into top level special folders called "Root" folders.
|
||||||
Your main story text lives in the "Novel" root folder. You can have multiple such folders in a
|
Your main story text lives in the "Novel" root folder. You can have multiple such folders in a
|
||||||
project. This allows you to keep a series of individual novels with the same characters and
|
project, and rename them to whatever you want. This allows you to keep a series of individual
|
||||||
world building in the same project, and create manuscripts for them individually.
|
novels with the same characters and world building in the same project, and create manuscripts
|
||||||
|
for them individually.
|
||||||
|
|
||||||
**Keep track of your story elements**
|
**Keep track of your story elements**
|
||||||
All notes in your project can be assigned a :term:`tag` that you can then :term:`reference` from
|
All notes in your project can be assigned a :term:`tag` that you can then :term:`reference` from
|
||||||
any other document or note. In fact, you can add a new tag under each heading of a note if you
|
any other document or note. In fact, you can add a new tag under each heading of a note if you
|
||||||
need to be able to reference specific sections of it.
|
need to be able to reference specific sections of it, or you want to keep several topics in the
|
||||||
|
same note.
|
||||||
|
|
||||||
**Get an overview of your story**
|
**Get an overview of your story**
|
||||||
It is not the documents themselves that define the chapters and scenes of your story, but the
|
It is not the documents themselves that define the chapters and scenes of your story, but the
|
||||||
headings that separate them. In the **Outline View** on the main window you can see an outline
|
headings that separate them. In the **Outline View** on the main window you can see an outline
|
||||||
of all the chapter and scene headings of your project. If they have any references in them, like
|
of all the chapter and scene headings of each novel root folder in your project. If they have
|
||||||
which character is in what chapter and scene, these are listed in additional columns.
|
any references in them, like which character is in what chapter and scene, these are listed in
|
||||||
|
additional columns.
|
||||||
|
|
||||||
You can also add a synopsis to each chapter or scene, which can be listed here as well. You have
|
You can also add a synopsis to each chapter or scene, which can be listed here as well. You have
|
||||||
the option to add or remove columns of information from this outline. A subset of the outline
|
the option to add or remove columns of information from this outline. A subset of the outline
|
||||||
@@ -100,9 +107,9 @@ Below are some key features of novelWriter.
|
|||||||
Whether you want to assemble a manuscript, or export all your notes, or generate an outline of
|
Whether you want to assemble a manuscript, or export all your notes, or generate an outline of
|
||||||
your chapters and scenes with a synopsis included, you can use the **Build Manuscript** tool to
|
your chapters and scenes with a synopsis included, you can use the **Build Manuscript** tool to
|
||||||
do so. The tool lets you select what information you want to include in the generated document,
|
do so. The tool lets you select what information you want to include in the generated document,
|
||||||
and how it is formatted. You can send the result to a printer, a PDF, or to an Open Document
|
and how it is formatted. You can send the result to a printer or PDF, or generate an Open
|
||||||
file that can be opened by most office type word processors. You can also generate the result
|
Document file that can be opened by most office type word processors. You can also generate the
|
||||||
as HTML, or Markdown, both suitable for further conversion to other formats.
|
result as HTML, or Markdown, both suitable for further conversion to other formats.
|
||||||
|
|
||||||
|
|
||||||
.. _a_intro_screenshots:
|
.. _a_intro_screenshots:
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ but you don't need all of them to get started.
|
|||||||
The chapters below labelled "Essential Information" are the ones you need to know to use the
|
The chapters below labelled "Essential Information" are the ones you need to know to use the
|
||||||
application correctly. By "correctly", it is meant: in a way so novelWriter understands the basic
|
application correctly. By "correctly", it is meant: in a way so novelWriter understands the basic
|
||||||
structure of your text. It collects a lot of information from your text and uses it to display the
|
structure of your text. It collects a lot of information from your text and uses it to display the
|
||||||
structure of it in various ways to help you get an overview of your project.
|
structure of it in various ways to help you get an overview of your writing.
|
||||||
|
|
||||||
The chapters labelled "Recommended Reading" includes additional information on how the different
|
The chapters labelled "Recommended Reading" includes additional information on how the different
|
||||||
parts if the application work and what the features do.
|
parts if the application work and what the features do.
|
||||||
|
|||||||
@@ -306,7 +306,8 @@ Status and Importance Tabs
|
|||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
Each document or folder of type **Novel** can be given a "Status" label accompanied by a coloured
|
Each document or folder of type **Novel** can be given a "Status" label accompanied by a coloured
|
||||||
icon, and each document or folder of the remaining types can be given an "Importance" label.
|
icon with an optional shape selected from a list of pre-defined shapes. Each document or folder of
|
||||||
|
the remaining types can be given an "Importance" label with the same customisation options.
|
||||||
|
|
||||||
These labels are there purely for your convenience, and you are not required to use them for any
|
These labels are there purely for your convenience, and you are not required to use them for any
|
||||||
other features to work. No other part of novelWriter accesses this information. The intention is to
|
other features to work. No other part of novelWriter accesses this information. The intention is to
|
||||||
|
|||||||
@@ -43,8 +43,8 @@ project-related tools and quick access to settings at the bottom.
|
|||||||
|
|
||||||
.. versionadded:: 2.2
|
.. versionadded:: 2.2
|
||||||
A number of new formatting options were added in 2.2 to allow for some special formatting cases.
|
A number of new formatting options were added in 2.2 to allow for some special formatting cases.
|
||||||
At the same time, a small formatting toolbar was added in the editor. It is hidden by default,
|
At the same time, a small formatting toolbar was added to the editor. It is hidden by default,
|
||||||
but can be opened by pressing the icon button in the top right corner.
|
but can be opened by pressing the button in the top right corner of the editor header.
|
||||||
|
|
||||||
|
|
||||||
Project Tree and Editor View
|
Project Tree and Editor View
|
||||||
@@ -148,6 +148,20 @@ in the document editor that acts on the open document.
|
|||||||
.. versionadded:: 2.4
|
.. versionadded:: 2.4
|
||||||
|
|
||||||
|
|
||||||
|
Switching Focus
|
||||||
|
---------------
|
||||||
|
|
||||||
|
If the project or novel view does not have focus, pressing :kbd:`Ctrl+T` switches focus to
|
||||||
|
whichever of the two is visible. If one of them already has focus, the key press will switch
|
||||||
|
between them instead.
|
||||||
|
|
||||||
|
Likewise, pressing :kbd:`Ctrl+E` with switch focus to the document editor or viewer, or if any of
|
||||||
|
them already have focus, it will switch focus between them,
|
||||||
|
|
||||||
|
These two shortcuts makes it possible to jump between all these GUI elements without having to
|
||||||
|
reach for the mouse or touchpad.
|
||||||
|
|
||||||
|
|
||||||
.. _a_breakdown_project:
|
.. _a_breakdown_project:
|
||||||
|
|
||||||
Project Layout
|
Project Layout
|
||||||
|
|||||||
@@ -54,7 +54,8 @@ At the top of the project tree, you will find a set of buttons.
|
|||||||
* The next two buttons can be used to move items up and down in the project tree. This is the only
|
* The next two buttons can be used to move items up and down in the project tree. This is the only
|
||||||
way to move root folders.
|
way to move root folders.
|
||||||
* The next button opens a dropdown menu for adding new items to the tree. This includes root
|
* The next button opens a dropdown menu for adding new items to the tree. This includes root
|
||||||
folders. You can also activate this dropdown menu by pressing :kbd:`Ctrl+N`.
|
folders and template documents. You can also activate this dropdown menu by pressing
|
||||||
|
:kbd:`Ctrl+N`.
|
||||||
* The last button is a menu of further actions you can apply to the project tree.
|
* The last button is a menu of further actions you can apply to the project tree.
|
||||||
|
|
||||||
Below the project tree you will find a small details panel showing the full information of the
|
Below the project tree you will find a small details panel showing the full information of the
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ Main Window Shortcuts
|
|||||||
":kbd:`F9`", "Re-build the project's index"
|
":kbd:`F9`", "Re-build the project's index"
|
||||||
":kbd:`F11`", "Toggle full screen mode"
|
":kbd:`F11`", "Toggle full screen mode"
|
||||||
":kbd:`Ctrl+,`", "Open the **Preferences** dialog"
|
":kbd:`Ctrl+,`", "Open the **Preferences** dialog"
|
||||||
":kbd:`Ctrl+E`", "Switch focus to the document editor"
|
":kbd:`Ctrl+E`", "Switch or toggle focus for the editor or viewer"
|
||||||
":kbd:`Ctrl+T`", "Switch or toggle focus for the project tree or novel view"
|
":kbd:`Ctrl+T`", "Switch or toggle focus for the project tree or novel view"
|
||||||
":kbd:`Ctrl+Q`", "Exit novelWriter"
|
":kbd:`Ctrl+Q`", "Exit novelWriter"
|
||||||
":kbd:`Ctrl+Shift+,`", "Open the **Project Settings** dialog"
|
":kbd:`Ctrl+Shift+,`", "Open the **Project Settings** dialog"
|
||||||
|
|||||||
Reference in New Issue
Block a user