Update the usage section
This commit is contained in:
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 35 KiB |
@@ -10,7 +10,7 @@ How it Works
|
|||||||
|
|
||||||
The main features of novelWriter are listed in the :ref:`a_intro` chapter. In this chapter, we go
|
The main features of novelWriter are listed in the :ref:`a_intro` chapter. In this chapter, we go
|
||||||
into some more details on how they are implemented. This is intended as an overview. Later on in
|
into some more details on how they are implemented. This is intended as an overview. Later on in
|
||||||
this documentation, these features will be covered in more detail.
|
this documentation these features will be covered in more detail.
|
||||||
|
|
||||||
|
|
||||||
.. _a_breakdown_design:
|
.. _a_breakdown_design:
|
||||||
@@ -23,6 +23,8 @@ at the same time provide useful features needed for writing a novel.
|
|||||||
|
|
||||||
The main window does not have an editor toolbar like many other applications do. This reduces
|
The main window does not have an editor toolbar like many other applications do. This reduces
|
||||||
clutter, and since the documents are formatted with style tags, it is more or less redundant.
|
clutter, and since the documents are formatted with style tags, it is more or less redundant.
|
||||||
|
Still, a small formatting toolbar can be popped out by clicking the three dots in the header of the
|
||||||
|
document editor to give quick access to standard formatting codes.
|
||||||
|
|
||||||
Most formatting features supported are available through convenient keyboard shortcuts. They are
|
Most formatting features supported are available through convenient keyboard shortcuts. They are
|
||||||
also available in the main menu, so you don't have to look up formatting codes every time you need
|
also available in the main menu, so you don't have to look up formatting codes every time you need
|
||||||
@@ -31,7 +33,8 @@ them. For reference, a list of all shortcuts can be found in the :ref:`a_kb` cha
|
|||||||
.. note::
|
.. note::
|
||||||
novelWriter is not intended to be a full office type word processor. It doesn't support images,
|
novelWriter is not intended to be a full office type word processor. It doesn't support images,
|
||||||
links, tables, and other complex structures and objects often needed for such documents.
|
links, tables, and other complex structures and objects often needed for such documents.
|
||||||
Formatting is limited to headers, emphasis, text alignment, and a few other simple features.
|
Formatting is limited to headings, in-line basic text formats, text alignment, and a few other
|
||||||
|
simple features.
|
||||||
|
|
||||||
On the left side of the main window, you will find a sidebar. This bar has buttons for the standard
|
On the left side of the main window, you will find a sidebar. This bar has buttons for the standard
|
||||||
views you can switch between, a quick link to the :guilabel:`Build Manuscript` tool, and a set of
|
views you can switch between, a quick link to the :guilabel:`Build Manuscript` tool, and a set of
|
||||||
@@ -54,18 +57,18 @@ When in :guilabel:`Project Tree View` mode, the main work area of the main windo
|
|||||||
or optionally three, panels. The left-most panel contains the project tree and all the documents in
|
or optionally three, panels. The left-most panel contains the project tree and all the documents in
|
||||||
your project. The second panel is the document editor.
|
your project. The second panel is the document editor.
|
||||||
|
|
||||||
An optional third panel on the right contains a document viewer which can view any document in your
|
An optional third panel on the right side contains a document viewer which can view any document in
|
||||||
project independently of what is open in the document editor. This panel is not intended as a
|
your project independently of what is open in the document editor. This panel is not intended as a
|
||||||
preview window, although you can use it for this purpose if you wish as it will apply the
|
preview window, although you can use it for this purpose if you wish if you need to check that the
|
||||||
formatting tags you have specified. The main purpose of the viewer is for viewing your notes next
|
formatting tags behave as you expected. The main purpose of the viewer is for viewing your notes
|
||||||
to your editor while you're writing.
|
next to your editor while you're writing.
|
||||||
|
|
||||||
The editor also has a :guilabel:`Focus Mode` you can toggle either from the menu, from the icon in
|
The editor also has a :guilabel:`Focus Mode` you can toggle either from the menu, from the icon in
|
||||||
the editor's header, or by pressing :kbd:`F8`. When :guilabel:`Focus Mode` is enabled, all the user
|
the editor's header, or by pressing :kbd:`F8`. When :guilabel:`Focus Mode` is enabled, all the user
|
||||||
interface elements other than the document editor itself are hidden away.
|
interface elements other than the document editor itself are hidden away.
|
||||||
|
|
||||||
|
|
||||||
Novel Tree and Editor View
|
Novel View and Editor View
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
.. figure:: images/fig_novel_tree_view.png
|
.. figure:: images/fig_novel_tree_view.png
|
||||||
@@ -81,17 +84,17 @@ Each heading is indented according to the heading level. You can open and edit y
|
|||||||
from this view as well. All headings contained in the currently open document should be highlighted
|
from this view as well. All headings contained in the currently open document should be highlighted
|
||||||
in the view to indicate which ones belong together in the same document.
|
in the view to indicate which ones belong together in the same document.
|
||||||
|
|
||||||
If you have multiple Novel root folders, the header of the novel view becomes a dropdown box. You
|
If you have multiple "Novel" type root folders, the header of the novel view becomes a dropdown
|
||||||
can then switch between them by clicking the :guilabel:`Outline of ...` text. You can also click
|
box. You can then switch between them by clicking the :guilabel:`Outline of ...` text. You can also
|
||||||
the novel icon button next to it.
|
click the novel icon button next to it.
|
||||||
|
|
||||||
Generally, the novel view should update when you make changes to the novel structure, including
|
Generally, the novel view should update when you make changes to the novel structure, including
|
||||||
edits of the current document in the editor. The information is only updated when the automatic
|
edits of the current document in the editor. The information is only updated when the automatic
|
||||||
save of the document is triggered, or you manually press :kbd:`Ctrl+S` to save changes. (You can
|
save of the document is triggered, or you manually press :kbd:`Ctrl+S` to save changes. (You can
|
||||||
adjust the auto-save interval in :guilabel:`Preferences`.) You can also regenerate the whole novel
|
adjust the auto-save interval in :guilabel:`Preferences`.) You can also regenerate the whole novel
|
||||||
view by pressing the refresh button at the top of the side panel.
|
view by pressing the refresh button in the novel view header.
|
||||||
|
|
||||||
It is possible to show an optional third column in the novel view, The settings are available from
|
It is possible to show an optional third column in the novel view. The settings are available from
|
||||||
the menu button in the toolbar.
|
the menu button in the toolbar.
|
||||||
|
|
||||||
If you click the arrow icon to the right of each item, a tooltip will pop out showing you all the
|
If you click the arrow icon to the right of each item, a tooltip will pop out showing you all the
|
||||||
@@ -123,12 +126,12 @@ neutral colours from :guilabel:`Preferences`. Other colour themes are also avail
|
|||||||
can be contributed to novelWriter on GitHub.
|
can be contributed to novelWriter on GitHub.
|
||||||
|
|
||||||
Switching the GUI colour theme does not affect the colours of the editor and viewer. They have
|
Switching the GUI colour theme does not affect the colours of the editor and viewer. They have
|
||||||
separate colour themes called :guilabel:`Editor Themes`. They are separated because there are a lot
|
separate colour selectable from the "Document colour theme" setting in :guilabel:`Preferences`.
|
||||||
more options to choose from for the editor and viewer.
|
They are separated because there are a lot more options to choose from for the editor and viewer.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
If you switch to dark mode on the GUI, you should also switch editor theme to match, otherwise
|
If you switch between light and dark mode on the GUI, you should also switch editor theme to
|
||||||
icons may be hard to see in the editor and viewer.
|
match, otherwise icons may be hard to see in the editor and viewer.
|
||||||
|
|
||||||
|
|
||||||
.. _a_breakdown_project:
|
.. _a_breakdown_project:
|
||||||
@@ -147,7 +150,7 @@ within those documents.
|
|||||||
|
|
||||||
.. figure:: images/fig_header_levels.png
|
.. figure:: images/fig_header_levels.png
|
||||||
|
|
||||||
An illustration of how header levels correspond to the novel structure.
|
An illustration of how heading levels correspond to the novel structure.
|
||||||
|
|
||||||
The four heading levels (**H1** to **H4**) are treated as follows:
|
The four heading levels (**H1** to **H4**) are treated as follows:
|
||||||
|
|
||||||
@@ -158,8 +161,8 @@ The four heading levels (**H1** to **H4**) are treated as follows:
|
|||||||
|
|
||||||
The project tree will select an icon for the document based on the first heading in it.
|
The project tree will select an icon for the document based on the first heading in it.
|
||||||
|
|
||||||
This header level structure is only taken into account for :term:`novel documents`. For
|
This heading level structure is only taken into account for :term:`novel documents`. For
|
||||||
:term:`project notes`, the header levels have no structural meaning, and you are free to use them
|
:term:`project notes`, the heading levels have no structural meaning, and you are free to use them
|
||||||
however you want. See :ref:`a_struct` and :ref:`a_references` for more details.
|
however you want. See :ref:`a_struct` and :ref:`a_references` for more details.
|
||||||
|
|
||||||
.. versionadded:: 2.0
|
.. versionadded:: 2.0
|
||||||
@@ -171,8 +174,8 @@ however you want. See :ref:`a_struct` and :ref:`a_references` for more details.
|
|||||||
|
|
||||||
.. _a_breakdown_export:
|
.. _a_breakdown_export:
|
||||||
|
|
||||||
Building the Manuscript
|
Building a Manuscript
|
||||||
=======================
|
=====================
|
||||||
|
|
||||||
The project can at any time be assembled into a range of different formats through the
|
The project can at any time be assembled into a range of different formats through the
|
||||||
:guilabel:`Build Manuscript` tool. Natively, novelWriter supports `Open Document`_, HTML5, and
|
:guilabel:`Build Manuscript` tool. Natively, novelWriter supports `Open Document`_, HTML5, and
|
||||||
@@ -217,8 +220,8 @@ Secondly, having multiple small files means it is very easy to synchronise them
|
|||||||
with standard file synchronisation tools.
|
with standard file synchronisation tools.
|
||||||
|
|
||||||
Thirdly, if you use version control software to track the changes to your project, the file formats
|
Thirdly, if you use version control software to track the changes to your project, the file formats
|
||||||
used for the files are well suited. Also the JSON documents have line breaks and indents, which
|
used for the files are well suited. All the JSON documents have line breaks and indents as well,
|
||||||
makes it easier to track them with version control software.
|
which makes it easier to track them with version control software.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
Since novelWriter has to keep track of a bunch of files and folders when a project is open, it
|
Since novelWriter has to keep track of a bunch of files and folders when a project is open, it
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ Formatting Your Text
|
|||||||
|
|
||||||
The novelWriter text editor is a plain text editor that uses formatting codes for setting meta data
|
The novelWriter text editor is a plain text editor that uses formatting codes for setting meta data
|
||||||
values and allowing for some text formatting. The syntax is based on Markdown, but novelWriter is
|
values and allowing for some text formatting. The syntax is based on Markdown, but novelWriter is
|
||||||
*not* a Markdown editor. It supports basic formatting like emphasis (italic), strong importance
|
**not** a Markdown editor. It supports basic formatting like emphasis (italic), strong importance
|
||||||
(bold) and strike through text, as well as four levels of headings. Form some further complex
|
(bold) and strike through text, as well as four levels of headings. For some further complex
|
||||||
formatting needs, a set of shortcodes can be used.
|
formatting needs, a set of shortcodes can be used.
|
||||||
|
|
||||||
In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a set of
|
In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a set of
|
||||||
@@ -30,7 +30,7 @@ dialogue in your text.
|
|||||||
An example of the colour highlighting of references. "Bob" is not defined, and "@blabla" is not
|
An example of the colour highlighting of references. "Bob" is not defined, and "@blabla" is not
|
||||||
a valid reference type.
|
a valid reference type.
|
||||||
|
|
||||||
When you use the commands to set tags and references, these also change colour. Correct commands
|
When you use the keywords to set tags and references, these also change colour. Correct keywords
|
||||||
have a distinct colour, and the references themselves will get a colour if they are valid. Invalid
|
have a distinct colour, and the references themselves will get a colour if they are valid. Invalid
|
||||||
references will get a squiggly error line underneath. The same applies to duplicate tags.
|
references will get a squiggly error line underneath. The same applies to duplicate tags.
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ Headings
|
|||||||
|
|
||||||
.. figure:: images/fig_header_levels.png
|
.. figure:: images/fig_header_levels.png
|
||||||
|
|
||||||
An illustration of how header levels correspond to the novel structure.
|
An illustration of how heading levels correspond to the novel structure.
|
||||||
|
|
||||||
Four levels of headings are allowed. For :term:`project notes`, they are free to be used as you see
|
Four levels of headings are allowed. For :term:`project notes`, they are free to be used as you see
|
||||||
fit. That is, novelWriter doesn't assign the different headings any particular meaning. However,
|
fit. That is, novelWriter doesn't assign the different headings any particular meaning. However,
|
||||||
@@ -53,28 +53,28 @@ for :term:`novel documents` they indicate the structural level of the novel and
|
|||||||
correctly to produce the intended result. See :ref:`a_struct_heads` for more details.
|
correctly to produce the intended result. See :ref:`a_struct_heads` for more details.
|
||||||
|
|
||||||
``# Title Text``
|
``# Title Text``
|
||||||
Heading level one. For novel documents, the header level indicates the start of a new partition.
|
Heading level one. For novel documents, the level indicates the start of a new partition.
|
||||||
|
|
||||||
``## Title Text``
|
``## Title Text``
|
||||||
Heading level two. For novel documents, the header level indicates the start of a new chapter.
|
Heading level two. For novel documents, the level indicates the start of a new chapter. Chapter
|
||||||
Chapter numbers can be inserted automatically when building the manuscript.
|
numbers can be inserted automatically when building the manuscript.
|
||||||
|
|
||||||
``### Title Text``
|
``### Title Text``
|
||||||
Heading level three. For novel documents, the header level indicates the start of a new scene.
|
Heading level three. For novel documents, the level indicates the start of a new scene. Scene
|
||||||
Scene numbers or scene separators can be inserted automatically when building the manuscript,
|
numbers or scene separators can be inserted automatically when building the manuscript, so you
|
||||||
so you can use the title field as a working title for your scenes if you wish.
|
can use the title field as a working title for your scenes if you wish.
|
||||||
|
|
||||||
``#### Title Text``
|
``#### Title Text``
|
||||||
Heading level four. For novel documents, the header level indicates the start of a new section.
|
Heading level four. For novel documents, the level indicates the start of a new section. Section
|
||||||
Section titles can be replaced by separators or ignored completely when building the manuscript.
|
titles can be replaced by separators or ignored completely when building the manuscript.
|
||||||
|
|
||||||
For headers level one and two, adding a ``!`` modifies the behaviour of the heading:
|
For headings level one and two, adding a ``!`` modifies its meaning:
|
||||||
|
|
||||||
``#! Title Text``
|
``#! Title Text``
|
||||||
This tells the build tool that the level one heading is intended to be used for the novel's
|
This tells the build tool that the level one heading is intended to be used for the novel's or
|
||||||
main title, like for instance on the front page. When building the manuscript, this will use a
|
notes folder's main title, like for instance on the front page. When building the manuscript,
|
||||||
different styling and will exclude the title from, for instance, a Table of Contents in Libre
|
this will use a different styling and will exclude the title from, for instance, a Table of
|
||||||
Office.
|
Contents in Libre Office.
|
||||||
|
|
||||||
``##! Title Text``
|
``##! Title Text``
|
||||||
This tells the build tool to not assign a chapter number to this chapter title if automatic
|
This tells the build tool to not assign a chapter number to this chapter title if automatic
|
||||||
@@ -99,10 +99,10 @@ In addition, the editor supports a few additional types of white spaces:
|
|||||||
|
|
||||||
* A non-breaking space can be inserted with :kbd:`Ctrl+K`, :kbd:`Space`.
|
* A non-breaking space can be inserted with :kbd:`Ctrl+K`, :kbd:`Space`.
|
||||||
* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl+K`, :kbd:`Shift+Space`.
|
* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl+K`, :kbd:`Shift+Space`.
|
||||||
* Non-breaking thin space can be inserted with :kbd:`Ctrl+K`, :kbd:`Ctrl+Space`.
|
* Non-breaking thin space can be inserted with :kbd:`Ctrl+K`, :kbd:`Ctrl+Space`.
|
||||||
|
|
||||||
These are all insert features, and the :guilabel:`Insert` menu has more. They are also listed
|
These are all insert features, and the :guilabel:`Insert` menu has more. The keyboard shortcuts for
|
||||||
in :ref:`a_kb_ins`.
|
them are also listed in :ref:`a_kb_ins`.
|
||||||
|
|
||||||
Non-breaking spaces are highlighted by the syntax highlighter with an alternate coloured
|
Non-breaking spaces are highlighted by the syntax highlighter with an alternate coloured
|
||||||
background, depending on the selected theme.
|
background, depending on the selected theme.
|
||||||
@@ -118,7 +118,7 @@ background, depending on the selected theme.
|
|||||||
Text Emphasis
|
Text Emphasis
|
||||||
=============
|
=============
|
||||||
|
|
||||||
A minimal set of text emphasis styles are supported for text paragraphs.
|
A minimal set of Markdown text emphasis styles are supported for text paragraphs.
|
||||||
|
|
||||||
``_text_``
|
``_text_``
|
||||||
The text is rendered as emphasised text (italicised).
|
The text is rendered as emphasised text (italicised).
|
||||||
@@ -141,7 +141,7 @@ In addition, the following rules apply:
|
|||||||
tag itself. That is, ``**text**`` is valid, ``**text **`` is not.
|
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
|
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.
|
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*
|
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
|
wrapper. This is due to the underscore also being a valid word character, so if they are on the
|
||||||
outside, they violate rule 2.
|
outside, they violate rule 2.
|
||||||
4. Text emphasis does not span past line breaks. If you need to add emphasis to multiple lines or
|
4. Text emphasis does not span past line breaks. If you need to add emphasis to multiple lines or
|
||||||
@@ -214,9 +214,10 @@ indicate this by altering the colour of the word.
|
|||||||
document of the whole project.
|
document of the whole project.
|
||||||
|
|
||||||
``%Short: text ...``
|
``%Short: text ...``
|
||||||
This is a short description comment. It is identical to the synopsis comment, but is intended to
|
This is a short description comment. It is identical to the synopsis comment (they are
|
||||||
be used for project notes. The text shows up in the Reference panel below the document viewer in
|
interchangeable), but is intended to be used for project notes. The text shows up in the
|
||||||
the last column labelled :guilabel:`Short Description`.
|
Reference panel below the document viewer in the last column labelled
|
||||||
|
:guilabel:`Short Description`.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
Only one comment can be flagged as a synopsis or short comment for each heading. If multiple
|
Only one comment can be flagged as a synopsis or short comment for each heading. If multiple
|
||||||
@@ -232,11 +233,11 @@ Tags and References
|
|||||||
The document editor supports a set of keywords used for setting tags, and making references between
|
The document editor supports a set of keywords used for setting tags, and making references between
|
||||||
documents.
|
documents.
|
||||||
|
|
||||||
Tags use the command ``@tag:`` to define a tag. The tag can be set once per section defined by a
|
Tags use the keyword ``@tag:`` to define a tag. The tag can be set once per section defined by a
|
||||||
heading. Setting it multiple times under the same heading will just override the previous setting.
|
heading. Setting it multiple times under the same heading will just override the previous setting.
|
||||||
|
|
||||||
``@tag: value``
|
``@tag: value``
|
||||||
A tag command followed by the tag value, like for instance the name of a character.
|
A tag keyword followed by the tag value, like for instance the name of a character.
|
||||||
|
|
||||||
References can be set anywhere within a section, and are collected according to their category.
|
References can be set anywhere within a section, and are collected according to their category.
|
||||||
References are in the form:
|
References are in the form:
|
||||||
@@ -282,7 +283,7 @@ Examples:
|
|||||||
.. note::
|
.. note::
|
||||||
The text editor will not show the alignment and indentation live. But the viewer will show them
|
The text editor will not show the alignment and indentation live. But the viewer will show them
|
||||||
when you open the document there. It will of course also be reflected in the document generated
|
when you open the document there. It will of course also be reflected in the document generated
|
||||||
from the build tool as long as the format supports paragraph alignment.
|
from the manuscript build tool as long as the format supports paragraph alignment.
|
||||||
|
|
||||||
|
|
||||||
.. _a_fmt_break:
|
.. _a_fmt_break:
|
||||||
@@ -290,24 +291,24 @@ Examples:
|
|||||||
Vertical Space and Page Breaks
|
Vertical Space and Page Breaks
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
Adding more than one line break between paragraphs will *not* increase the space between those
|
Adding more than one line break between paragraphs will **not** increase the space between those
|
||||||
paragraphs when building the project. To add additional space between paragraphs, add the text
|
paragraphs when building the project. To add additional space between paragraphs, add the text
|
||||||
``[VSPACE]`` on a line of its own, and the build tool will insert a blank paragraph in its place.
|
``[vspace]`` on a line of its own, and the build tool will insert a blank paragraph in its place.
|
||||||
|
|
||||||
If you need multiple blank paragraphs just add a colon and a number to the above code. For
|
If you need multiple blank paragraphs just add a colon and a number to the above code. For
|
||||||
instance, writing ``[VSPACE:3]`` will insert three blank paragraphs.
|
instance, writing ``[vspace:3]`` will insert three blank paragraphs.
|
||||||
|
|
||||||
Normally, the build tool will insert a page break before all headers of level one and for all
|
Normally, the manuscript build tool will insert a page break before all headings of level one and
|
||||||
headers of level two for novel documents, i.e. chapters, but not for project notes.
|
for all headings of level two for novel documents, i.e. chapters, but not for project notes.
|
||||||
|
|
||||||
If you need to add a page break somewhere else, put the text ``[NEW PAGE]`` on a line by itself
|
If you need to add a page break somewhere else, put the text ``[new page]`` on a line by itself
|
||||||
before the text you wish to start on a new page.
|
before the text you wish to start on a new page.
|
||||||
|
|
||||||
If you want page breaks for scenes and sections, you must add them manually.
|
If you want page breaks for scenes and sections, you must add them manually.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The page break code is applied to the text that follows it. It adds a "page break before" mark
|
The page break code is applied to the text that follows it. It adds a "page break before" mark
|
||||||
to the text when exporting to HTML or Open Document. This means that a ``[NEW PAGE]`` which has
|
to the text when exporting to HTML or Open Document. This means that a ``[new page]`` which has
|
||||||
no text following it, it will not result in a page break.
|
no text following it, it will not result in a page break.
|
||||||
|
|
||||||
**Example:**
|
**Example:**
|
||||||
@@ -316,11 +317,11 @@ If you want page breaks for scenes and sections, you must add them manually.
|
|||||||
|
|
||||||
This is a text paragraph.
|
This is a text paragraph.
|
||||||
|
|
||||||
[VSPACE:2]
|
[vspace:2]
|
||||||
|
|
||||||
This is another text paragraph, but there will be two empty paragraphs
|
This is another text paragraph, but there will be two empty paragraphs
|
||||||
in-between them.
|
in-between them.
|
||||||
|
|
||||||
[NEWPAGE]
|
[new page]
|
||||||
|
|
||||||
This text will always start on a new page if the build format has pages.
|
This text will always start on a new page if the build format has pages.
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ Splitting Documents
|
|||||||
|
|
||||||
The :guilabel:`Split Document` dialog.
|
The :guilabel:`Split Document` dialog.
|
||||||
|
|
||||||
The :guilabel:`Split Document by Header` option will open a dialog that allows you to split the
|
The :guilabel:`Split Document by Heading` option will open a dialog that allows you to split the
|
||||||
selected document into multiple new documents based on the headings it contains. You can select at
|
selected document into multiple new documents based on the headings it contains. You can select at
|
||||||
which heading level the split is to be performed from the dropdown box. The list box will preview
|
which heading level the split is to be performed from the dropdown box. The list box will preview
|
||||||
which headings will be split into new documents.
|
which headings will be split into new documents.
|
||||||
@@ -94,7 +94,7 @@ which headings will be split into new documents.
|
|||||||
You are given the option to create a folder for these new documents, and whether or not to create a
|
You are given the option to create a folder for these new documents, and whether or not to create a
|
||||||
hierarchy of documents. That is, put sections under scenes, and scenes under chapters.
|
hierarchy of documents. That is, put sections under scenes, and scenes under chapters.
|
||||||
|
|
||||||
The source document *is not* deleted in the process, but you have the option to let the tool move
|
The source document **is not** deleted in the process, but you have the option to let the tool move
|
||||||
the source document to the :guilabel:`Trash` folder.
|
the source document to the :guilabel:`Trash` folder.
|
||||||
|
|
||||||
|
|
||||||
@@ -123,16 +123,16 @@ Document Importance and Status
|
|||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
Each document or folder in your project can have either a "Status" or "Importance" flag set. These
|
Each document or folder in your project can have either a "Status" or "Importance" flag set. These
|
||||||
are flags that you control and define yourself. novelWriter doesn't do anything with them at all.
|
are flags that you control and define yourself, and novelWriter doesn't use them for anything. To
|
||||||
To modify the labels, go to their respective tabs in :guilabel:`Project Settings`.
|
modify the labels, go to their respective tabs in :guilabel:`Project Settings`.
|
||||||
|
|
||||||
The "Status" flag is intended to tag a :term:`novel document<novel documents>` as for instance a
|
The "Status" flag is intended to tag a :term:`novel document<novel documents>` as for instance a
|
||||||
draft or as completed, and the "Importance" flag is intended to tag character notes, or other
|
draft or as completed, and the "Importance" flag is intended to tag character notes, or other
|
||||||
:term:`project notes`, as for instance a main, major, or minor character or story element.
|
:term:`project notes`, as for instance a main, major, or minor character or story element.
|
||||||
|
|
||||||
Whether a document uses a "Status" or "Importance" flag depends on which :term:`root folder` it
|
Whether a document uses a "Status" or "Importance" flag depends on which :term:`root folder` it
|
||||||
lives in. If it's in a :guilabel:`Novel` folder, it uses the "Status" flag, otherwise it uses an
|
lives in. If it's in a Novel type folder, it uses the "Status" flag, otherwise it uses an
|
||||||
"Importance" flag. Some folders, like :guilabel:`Trash` and :guilabel:`Archive` allow both.
|
"Importance" flag.
|
||||||
|
|
||||||
|
|
||||||
.. _a_ui_tree_dnd:
|
.. _a_ui_tree_dnd:
|
||||||
@@ -155,32 +155,31 @@ interface framework novelWriter is built upon.
|
|||||||
|
|
||||||
Documents and their folders can be rearranged freely within their root folders. If you move a Novel
|
Documents and their folders can be rearranged freely within their root folders. If you move a Novel
|
||||||
document out of a Novel folder, it will be converted to a project note. Notes can be moved freely
|
document out of a Novel folder, it will be converted to a project note. Notes can be moved freely
|
||||||
between all root folders, but keep in mind that if you move a note into a :guilabel:`Novel` root
|
between all root folders, but keep in mind that if you move a note into a Novel type root folder,
|
||||||
folder, its "Importance" setting will be switched with a "Status" setting. See
|
its "Importance" setting will be switched with a "Status" setting. See :ref:`a_ui_tree_status`. The
|
||||||
:ref:`a_ui_tree_status`. The old value will not be overwritten though, and should be restored if
|
old value will not be overwritten though, and should be restored if you move it back at some point.
|
||||||
you move it back at some point.
|
|
||||||
|
|
||||||
Root folders in the project tree cannot be dragged and dropped at all. If you want to reorder them,
|
Root folders in the project tree cannot be dragged and dropped at all. If you want to reorder them,
|
||||||
you can move them up or down with respect to each other from the arrow buttons at the top of the
|
you can move them up or down with respect to each other from the arrow buttons at the top of the
|
||||||
project tree, or by pressing :kbd:`Ctrl+Shift+Up` or :kbd:`Ctrl+Shift+Down` when they are selected.
|
project tree, or by pressing :kbd:`Ctrl+Up` or :kbd:`Ctrl+Down` when they are selected.
|
||||||
|
|
||||||
|
|
||||||
.. _a_ui_tree_novel:
|
.. _a_ui_tree_novel:
|
||||||
|
|
||||||
The Novel Tree
|
The Novel Tree View
|
||||||
==============
|
===================
|
||||||
|
|
||||||
.. figure:: images/fig_novel_tree_view.png
|
.. figure:: images/fig_novel_tree_view.png
|
||||||
|
|
||||||
A screenshot of the Novel Tree View.
|
A screenshot of the Novel Tree View.
|
||||||
|
|
||||||
An alternative way to view the project structure is the novel tree. You can switch to this view by
|
An alternative way to view the project structure is the novel view. You can switch to this view by
|
||||||
selecting the :guilabel:`Novel Tree View` button in the sidebar. This view is a simplified version
|
selecting the :guilabel:`Novel View` button in the sidebar. This view is a simplified version of
|
||||||
of the view in the :guilabel:`Outline View`. It is convenient when you want to browse the structure
|
the view in the :guilabel:`Outline View`. It is convenient when you want to browse the structure
|
||||||
of the story itself rather than the document files.
|
of the story itself rather than the document files.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
You cannot reorganise the entries in the novel tree, or add any new documents, as that would
|
You cannot reorganise the entries in the novel view, or add any new documents, as that would
|
||||||
imply restructuring the content of the document files themselves. Any such editing must be done
|
imply restructuring the content of the document files themselves. Any such editing must be done
|
||||||
in the project tree. However, you can add new headings to existing documents, or change
|
in the project tree. However, you can add new headings to existing documents, or change
|
||||||
references, which will be updated in this view when the document is saved.
|
references, which will be updated in this view when the document is saved.
|
||||||
@@ -188,17 +187,17 @@ of the story itself rather than the document files.
|
|||||||
|
|
||||||
.. _a_ui_outline:
|
.. _a_ui_outline:
|
||||||
|
|
||||||
Project Outline View
|
The Novel Outline View
|
||||||
====================
|
======================
|
||||||
|
|
||||||
.. figure:: images/fig_outline_view.png
|
.. figure:: images/fig_outline_view.png
|
||||||
|
|
||||||
A screenshot of the Novel Outline View.
|
A screenshot of the Novel Outline View.
|
||||||
|
|
||||||
The project's :guilabel:`Outline View` is available as another view option from the sidebar. The
|
The project's :guilabel:`Novel Outline View` is available as another view option from the sidebar.
|
||||||
outline provides an overview of the novel structure, displaying a tree hierarchy of the elements of
|
The outline provides an overview of the novel structure, displaying a tree hierarchy of the
|
||||||
the novel, that is, the level 1 to 4 headings representing partitions, chapters, scenes and
|
elements of the novel, that is, the level 1 to 4 headings representing partitions, chapters, scenes
|
||||||
sections.
|
and sections.
|
||||||
|
|
||||||
The document containing the heading can also be displayed as a separate column, as well as the line
|
The document containing the heading can also be displayed as a separate column, as well as the line
|
||||||
number where the heading is defined. Double-clicking an entry will open the corresponding document
|
number where the heading is defined. Double-clicking an entry will open the corresponding document
|
||||||
|
|||||||
@@ -23,14 +23,14 @@ Main Window Shortcuts
|
|||||||
":kbd:`F5`", "Open the :guilabel:`Build Manuscript` tool"
|
":kbd:`F5`", "Open the :guilabel:`Build Manuscript` tool"
|
||||||
":kbd:`F6`", "Open the :guilabel:`Writing Statistics` tool"
|
":kbd:`F6`", "Open the :guilabel:`Writing Statistics` tool"
|
||||||
":kbd:`F8`", "Toggle :guilabel:`Focus Mode`"
|
":kbd:`F8`", "Toggle :guilabel:`Focus Mode`"
|
||||||
":kbd:`F9`", "Re-build the project 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 :guilabel:`Preferences` dialog"
|
":kbd:`Ctrl+,`", "Open the :guilabel:`Preferences` dialog"
|
||||||
":kbd:`Ctrl+E`", "Switch focus to the document editor"
|
":kbd:`Ctrl+E`", "Switch focus to the document editor"
|
||||||
":kbd:`Ctrl+T`", "Switch focus to the project/novel tree"
|
":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 :guilabel:`Project Settings` dialog"
|
":kbd:`Ctrl+Shift+,`", "Open the :guilabel:`Project Settings` dialog"
|
||||||
":kbd:`Ctrl+Shift+O`", "Open a project"
|
":kbd:`Ctrl+Shift+O`", "Open the Welcome dialog to open or create a project"
|
||||||
":kbd:`Ctrl+Shift+S`", "Save the current project"
|
":kbd:`Ctrl+Shift+S`", "Save the current project"
|
||||||
":kbd:`Ctrl+Shift+T`", "Switch focus to the outline view"
|
":kbd:`Ctrl+Shift+T`", "Switch focus to the outline view"
|
||||||
":kbd:`Ctrl+Shift+W`", "Close the current project"
|
":kbd:`Ctrl+Shift+W`", "Close the current project"
|
||||||
@@ -55,12 +55,11 @@ Project Tree Shortcuts
|
|||||||
":kbd:`Ctrl+.`", "Open the context menu on the selected item"
|
":kbd:`Ctrl+.`", "Open the context menu on the selected item"
|
||||||
":kbd:`Ctrl+L`", "Open the :guilabel:`Quick Links` menu"
|
":kbd:`Ctrl+L`", "Open the :guilabel:`Quick Links` menu"
|
||||||
":kbd:`Ctrl+N`", "Open the :guilabel:`Create New Item` menu"
|
":kbd:`Ctrl+N`", "Open the :guilabel:`Create New Item` menu"
|
||||||
":kbd:`Ctrl+O`", "Open selected document"
|
":kbd:`Ctrl+O`", "Open the selected document in the editor"
|
||||||
":kbd:`Ctrl+R`", "Open the selected document in the viewer"
|
":kbd:`Ctrl+R`", "Open the selected document in the viewer"
|
||||||
":kbd:`Ctrl+Up`", "Move selected item one step up in the tree"
|
":kbd:`Ctrl+Up`", "Move selected item one step up in the tree"
|
||||||
":kbd:`Ctrl+Down`", "Move selected item one step down in the tree"
|
":kbd:`Ctrl+Down`", "Move selected item one step down in the tree"
|
||||||
":kbd:`Ctrl+Shift+Del`", "Move the selected item to Trash"
|
":kbd:`Ctrl+Shift+Del`", "Move the selected item to Trash"
|
||||||
":kbd:`Ctrl+Shift+Z`", "Undo the last move of a project item, if possible"
|
|
||||||
|
|
||||||
|
|
||||||
.. _a_kb_editor:
|
.. _a_kb_editor:
|
||||||
@@ -92,22 +91,22 @@ Text Formatting Shortcuts
|
|||||||
|
|
||||||
":kbd:`Ctrl+'`", "Wrap selected text, or word under cursor, in single quotes"
|
":kbd:`Ctrl+'`", "Wrap selected text, or word under cursor, in single quotes"
|
||||||
":kbd:`Ctrl+""`", "Wrap selected text, or word under cursor, in double quotes"
|
":kbd:`Ctrl+""`", "Wrap selected text, or word under cursor, in double quotes"
|
||||||
":kbd:`Ctrl+/`", "Toggle block format as comment"
|
":kbd:`Ctrl+/`", "Toggle block format as comment for block under cursor, or selected text"
|
||||||
":kbd:`Ctrl+0`", "Remove block formatting for block under cursor"
|
":kbd:`Ctrl+0`", "Remove block formatting for block under cursor, or selected text"
|
||||||
":kbd:`Ctrl+1`", "Change block format to header level 1"
|
":kbd:`Ctrl+1`", "Change block format to heading level 1"
|
||||||
":kbd:`Ctrl+2`", "Change block format to header level 2"
|
":kbd:`Ctrl+2`", "Change block format to heading level 2"
|
||||||
":kbd:`Ctrl+3`", "Change block format to header level 3"
|
":kbd:`Ctrl+3`", "Change block format to heading level 3"
|
||||||
":kbd:`Ctrl+4`", "Change block format to header level 4"
|
":kbd:`Ctrl+4`", "Change block format to heading level 4"
|
||||||
":kbd:`Ctrl+5`", "Change block alignment to left-aligned"
|
":kbd:`Ctrl+5`", "Change block alignment to left-aligned"
|
||||||
":kbd:`Ctrl+6`", "Change block alignment to centred"
|
":kbd:`Ctrl+6`", "Change block alignment to centred"
|
||||||
":kbd:`Ctrl+7`", "Change block alignment to right-aligned"
|
":kbd:`Ctrl+7`", "Change block alignment to right-aligned"
|
||||||
":kbd:`Ctrl+8`", "Add a left margin to the block"
|
":kbd:`Ctrl+8`", "Add a left margin to the block"
|
||||||
":kbd:`Ctrl+9`", "Add a right margin to the block"
|
":kbd:`Ctrl+9`", "Add a right margin to the block"
|
||||||
":kbd:`Ctrl+B`", "Format selected text, or word under cursor, with strong emphasis (bold)"
|
":kbd:`Ctrl+B`", "Format selected text, or word under cursor, with strong emphasis (bold)"
|
||||||
":kbd:`Ctrl+D`", "Strike through selected text, or word under cursor"
|
":kbd:`Ctrl+D`", "Format selected text, or word under cursor, with strike through"
|
||||||
":kbd:`Ctrl+I`", "Format selected text, or word under cursor, with emphasis (italic)"
|
":kbd:`Ctrl+I`", "Format selected text, or word under cursor, with emphasis (italic)"
|
||||||
":kbd:`Ctrl+Shift+/`", "Remove block formatting for block under cursor"
|
":kbd:`Ctrl+Shift+/`", "Remove block formatting for block under cursor, or selected text"
|
||||||
":kbd:`Ctrl+Shift+D`", "Toggle block format as ignored text"
|
":kbd:`Ctrl+Shift+D`", "Toggle block format as ignored text for block under cursor, or selected text"
|
||||||
|
|
||||||
|
|
||||||
Other Editor Shortcuts
|
Other Editor Shortcuts
|
||||||
@@ -116,7 +115,7 @@ Other Editor Shortcuts
|
|||||||
.. csv-table::
|
.. csv-table::
|
||||||
:header: "Shortcut", "Description"
|
:header: "Shortcut", "Description"
|
||||||
|
|
||||||
":kbd:`F7`", "Re-run the spell checker"
|
":kbd:`F7`", "Re-run the spell checker on the document"
|
||||||
":kbd:`Ctrl+.`", "Open the context menu at the current cursor location"
|
":kbd:`Ctrl+.`", "Open the context menu at the current cursor location"
|
||||||
":kbd:`Ctrl+A`", "Select all text in the document"
|
":kbd:`Ctrl+A`", "Select all text in the document"
|
||||||
":kbd:`Ctrl+C`", "Copy selected text to clipboard"
|
":kbd:`Ctrl+C`", "Copy selected text to clipboard"
|
||||||
@@ -133,7 +132,6 @@ Other Editor Shortcuts
|
|||||||
":kbd:`Ctrl+F7`", "Toggle spell checking"
|
":kbd:`Ctrl+F7`", "Toggle spell checking"
|
||||||
":kbd:`Ctrl+Return`", "Open the tag or reference under the cursor in the viewer"
|
":kbd:`Ctrl+Return`", "Open the tag or reference under the cursor in the viewer"
|
||||||
":kbd:`Ctrl+Shift+A`", "Select all text in the current paragraph"
|
":kbd:`Ctrl+Shift+A`", "Select all text in the current paragraph"
|
||||||
":kbd:`Ctrl+Shift+I`", "Import text to the current document from a text file"
|
|
||||||
|
|
||||||
|
|
||||||
.. _a_kb_ins:
|
.. _a_kb_ins:
|
||||||
|
|||||||
@@ -42,13 +42,12 @@ the label and pressing :kbd:`Ctrl+Return`. You can also control-click them with
|
|||||||
Editor Auto-Completer
|
Editor Auto-Completer
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
If you type the character ``@`` on a new line, a context menu will appear showing the different
|
If you type the character ``@`` on a new line, a menu will appear showing the different available
|
||||||
available keywords. The list will shorten as you type. Once a keyword command has been selected or
|
keywords. The list will shorten as you type. Once a keyword command has been selected or typed, the
|
||||||
typed, the editor may suggest further content based on your project content. See
|
editor may suggest further content based on your project content. See :ref:`a_references_completer`
|
||||||
:ref:`a_references_completer` for more details.
|
for more details.
|
||||||
|
|
||||||
.. versionadded:: 2.2
|
.. versionadded:: 2.2
|
||||||
The auto-completer feature was added.
|
|
||||||
|
|
||||||
|
|
||||||
.. _a_ui_view:
|
.. _a_ui_view:
|
||||||
|
|||||||
@@ -230,7 +230,6 @@ class GuiMainMenu(QMenuBar):
|
|||||||
|
|
||||||
# Document > Import From File
|
# Document > Import From File
|
||||||
self.aImportFile = self.docuMenu.addAction(self.tr("Import Text from File"))
|
self.aImportFile = self.docuMenu.addAction(self.tr("Import Text from File"))
|
||||||
self.aImportFile.setShortcut("Ctrl+Shift+I")
|
|
||||||
self.aImportFile.triggered.connect(lambda: self.mainGui.importDocument())
|
self.aImportFile.triggered.connect(lambda: self.mainGui.importDocument())
|
||||||
|
|
||||||
return
|
return
|
||||||
|
|||||||
Reference in New Issue
Block a user