Update docs with 2.2 features (#1640)

docs/source/int_customise.rst

@@ -7,7 +7,7 @@ Customisations
 .. _Enchant: https://abiword.github.io/enchant
 .. _Free Desktop: https://cgit.freedesktop.org/libreoffice/dictionaries/tree/
 
-There are a few ways you can customise novelWriter youself. Currently, you can add new GUI themes,
+There are a few ways you can customise novelWriter yourself. Currently, you can add new GUI themes,
 your own syntax themes, and install additional dictionaries.
 
 
@@ -22,23 +22,35 @@ may not load all installed spell check dictionaries automatically.
 Linux and MacOS
 ---------------
 
-On Linux and MacOS, you generally only have to install hunspell or aspell dictionaries on your
+On Linux and MacOS, you generally only have to install hunspell, aspell or myspell dictionaries on
-system like you do for other applications. See your distro or OS documentation for how to do this.
+your system like you do for other applications. See your distro or OS documentation for how to do
-These dictionaries should show up as available spell check languages in novelWriter.
+this. These dictionaries should show up as available spell check languages in novelWriter.
 
 Windows
 -------
 
 For Windows, English is included with the installation. For other languages you have to download
-and add dictionaries yourself. You can find the various dictionaries on the `Free Desktop`_
+and add dictionaries yourself.
-website. You should find a folder for your language, if it is available at all, and download the
+
-files ending with ``.aff`` and ``.dic``. These files must then be copied to the following location:
+**Install Tool**
+
+A small tool to assist with this can be found under :guilabel:`Tools > Add Dictionaries`. It will
+import spell checking dictionaries from Free Office or Libre Office extensions. The dictionaries
+are then installed in the install location for the Enchant library.
+
+**Manual Install**
+
+If you prefer to do this manually or want to use a different source than the ones mentioned above,
+You need to get compatible dictionary files for your language. You need two files files ending with
+``.aff`` and ``.dic``. These files must then be copied to the following location: 
 
 ``C:\Users\<USER>\AppData\Local\enchant\hunspell``
 
 This assumes your user profile is stored at ``C:\Users\<USER>``. The last one or two folders may
 not exist, so you may need to create them.
 
+You can find the various dictionaries on the `Free Desktop`_ website.
+
 .. note::
    The Free Desktop link points to a repository, and what may look like file links inside the
    dictionary folder are actually links to web pages. If you right-click and download those, you
@@ -53,7 +65,7 @@ not exist, so you may need to create them.
 Syntax and GUI Themes
 =====================
 
-Adding your own GUI and syntax themes is relatively easy, altough it requires that you manually
+Adding your own GUI and syntax themes is relatively easy, although it requires that you manually
 edit config files with colour values. The themes are defined by simple plain text config files with
 meta data and colour settings.
 
@@ -136,7 +148,7 @@ Omitted values are not loaded and will use default values.
 Custom Syntax Theme
 -------------------
 
-A syntax theme ``.conf`` file consists of the follwing settings:
+A syntax theme ``.conf`` file consists of the following settings:
 
 .. code-block:: cfg
 

docs/source/int_howto.rst

@@ -9,8 +9,8 @@ Tips & Tricks
 This is a list of hopefully helpful little tips on how to get the most out of novelWriter.
 
 .. note::
-   This section will be expanded over time, and if you would like to have something added, feel
+   This section will be expanded over time. If you would like to have something added, feel free to
-   free to contribute, or start a discussion on the project's `Discussions Page`_.
+   contribute, or start a discussion on the project's `Discussions Page`_.
 
 
 Managing the Project

docs/source/int_introduction.rst

@@ -13,8 +13,8 @@ formatting features available are limited to those relevant for this purpose. It
 for technical writing, and it is *not* a full-featured Markdown editor.
 
 Your novel project is organised as a collection of separate plain text documents instead of a
-single, large document. The idea here is to make it easier to reorganise your project structure
+single, large document. The idea is to make it easier to reorganise your project structure without
-without having to cut and paste text between chapters.
+having to cut and paste text between chapters.
 
 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
@@ -22,17 +22,17 @@ your notes about your characters, your world building, and so on.
 
 You can at any point split the individual documents by their headers up into multiple documents, or
 merge multiple documents into single documents. This makes it easier to use variations of the
-Snowflake_ method for writing. You can focus on writing larger structure-focused documents, like
+Snowflake_ method for writing. You can start by writing larger structure-focused documents, like
 one per act for instance, and later effortlessly split these up into scenes by their headers.
 
 Below are some key features of novelWriter.
 
 **Focus on writing**
-   The aim of the user interface is to let the user focus on writing instead of spending time
+   The aim of the user interface is to let you focus on writing instead of spending time formatting
-   formatting text. Formatting is therefore limited to a small set of formatting tags for simple
+   text. Formatting is therefore limited to a small set of formatting tags for simple things like
-   things like text emphasis and paragraph alignment. When you really want to focus on just
+   text emphasis and paragraph alignment. When you really want to focus on just writing, you can
-   writing, you can switch the editor into :guilabel:`Focus Mode` where only the text editor panel
+   switch the editor into :guilabel:`Focus Mode` where only the text editor panel itself is
-   itself is visible, and the project structure view is hidden away.
+   visible, and the project structure view is hidden away.
 
 **Keep an eye on your notes**
    The main window can optionally show a document viewer to the right of the editor. This view
@@ -45,8 +45,8 @@ Below are some key features of novelWriter.
    build the project into a manuscript, they are all glued together in the top-to-bottom order in
    which they appear in the project tree. You can use as few text documents as you like, but
    splitting the project up into chapters and scenes means you can easily reorder them using the
-   drag-and-drop feature. You can also start out with a few documents and then later split them
+   drag-and-drop feature of the project tree. You can also start out with a few documents and then
-   into multiple documents based on their headers.
+   later split them into multiple documents based on their headers.
 
 **Multi-novel project support**
    As of novelWriter 2.0, you can have multiple Novel type root folders in a project. This allows
@@ -56,9 +56,9 @@ Below are some key features of novelWriter.
 **Keep track of your plot elements**
    All notes in your project can be assigned a :term:`tag` that you can :term:`reference` from 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 ot.
+   to be able to reference specific sections of it.
 
-**Get an overview of your plot elements**
+**Get an overview of your story**
    In the :guilabel:`Outline View` on the main window you can see an outline of all the chapters,
    scenes, and sections of your project. If they have any references in them, these are listed in
    additional columns. You can also add a synopsis to each chapter or scene, which can be listed
@@ -66,6 +66,12 @@ Below are some key features of novelWriter.
    subset of the outline information is also available in the :guilabel:`Novel View` as an
    alternative view to the project tree.
 
+**Get an overview of your story elements**
+   Under the document viewer panel you will find a series of tabs that shows the different story
+   elements you have created tags for. The tabs are sorted into Characters, Plots, etc, depending
+   on which categories you are using in your story. This panel can be hidden when you don't need it
+   to free up space.
+
 **Building your manuscript**
    Whether you want to assemble a manuscript, or export all your notes, or generate an outline of
    your chapters and scenes with a synopsis, you can use the :guilabel:`Build Manuscript` tool to
@@ -83,9 +89,9 @@ Screenshots
 .. figure:: images/screenshot_default.png
    :class: dark-light
 
-   novelWriter with default theme
+   novelWriter with light colour theme
 
 .. figure:: images/screenshot_dark.png
    :class: dark-light
 
-   novelWriter with dark theme
+   novelWriter with dark colour theme

docs/source/int_overview.rst

@@ -36,15 +36,15 @@ read on.
    This chapter explains the basics of how the application works and what it can and cannot do.
 
 :ref:`a_ui_project` – Recommended Reading
-   This chapter will give you a more detailed explanation of how you can use the user interface components
+   This chapter will give you a more detailed explanation of how you can use the user interface
-   to organise and view your project work.
+   components to organise and view your project work.
 
 :ref:`a_ui_writing` – Recommended Reading
    This chapter will give you a more detailed explanation of how the text editor and viewer work.
 
 :ref:`a_fmt` – Essential Information
    This chapter covers how you should format your text. The editor is plain text, so text
-   formatting requires some basic markup. The structure of your novel is also inferred by how you
+   formatting requires some basic markup. The structure of your novel is also inferred from how you
    use headings. Tags and references are implemented by special keywords.
 
 :ref:`a_kb` – Optional / Lookup
@@ -55,7 +55,7 @@ read on.
 :ref:`a_typ` – Optional
    This chapter gives you an overview of the special typographical symbols available in
    novelWriter. The auto-replace feature can handle the insertion of standard quote symbols for
-   your language, and other special characters. If you use any symbols aside from these. their
+   your language, and other special characters. If you use any symbols aside from these, their
    intended use is explained here.
 
 :ref:`a_prjfmt` – Optional

docs/source/int_started.rst

@@ -14,8 +14,8 @@ Getting Started
 .. _Releases: https://github.com/vkbo/novelWriter/releases
 .. _AppImage: https://appimage.org/
 
-Package installers for novelWriter are available for all major platforms, including Linux, Windows
+Ready-made packages and installers for novelWriter are available for all major platforms, including
-and MacOS. See below for install instructions for each platform.
+Linux, Windows and MacOS. See below for install instructions for each platform.
 
 You can also install novelWriter from the Python Package Index (PyPi). See :ref:`a_started_pip`.
 Installing from PyPi does not set up icon launchers, so you will either have to do this yourself,

docs/source/project_overview.rst

@@ -5,7 +5,7 @@ Novel Projects
 **************
 
 New projects can be created from the :guilabel:`Project` menu by selecting :guilabel:`New Project`.
-This will open the :guilabel:`New Project Wizard` that will assist you in creating a barebone
+This will open the :guilabel:`New Project Wizard` that will assist you in creating a bare bone
 project suited to your needs.
 
 A novelWriter project requires a dedicated folder for storing its files on the local file system.
@@ -41,7 +41,7 @@ to reference them from other documents and notes. The intended usage of each typ
 listed below. However, aside from the :guilabel:`Novel` folder, no restrictions are applied by the
 application on what you put in them. You can use them however you want.
 
-The root folder system is closesly connected to how the Tags and References system works. For more
+The root folder system is closely connected to how the Tags and References system works. For more
 details, see the :ref:`a_references` chapter.
 
 :guilabel:`Novel`

docs/source/project_references.rst

@@ -28,7 +28,7 @@ Metadata in novelWriter
 
 The structure of your novelWriter project is inferred from the :term:`headings` within the
 documents, not the documents themselves. See :ref:`a_struct_heads` for more details. Therefore,
-metadata is also associated with headings, and not documents.
+metadata is also associated with headings, and not the documents directly.
 
 If you split your project into separate documents for each scene, this distinction may not matter.
 However, there are several benefits to using documents at a larger structural scale when starting
@@ -51,9 +51,8 @@ by using the ``@tags`` :term:`keyword`. The full format of a tag is ``@tag: tagn
 ``tagname`` is an identifier of your choosing. You can only set *one* tag per heading, and the tag
 has to be unique across all documents in the project.
 
-.. note::
+.. versionadded:: 2.2
-   In version 2.2, tags will be made case insensitive, but as of novelWriter 2.1 they are not. You
+   Tags are now case insensitive.
-   should however avoid using tags that are only distinguished by case.
 
 After the tags have been defined, they can then be referenced in the novel documents, or
 cross-referenced in other notes. they will also show up in the :guilabel:`Outline View` and in the
@@ -64,10 +63,10 @@ allowed, that is, the tag is unique. Duplicate tags should be detected as long a
 to date. An invalid tag should have a green wiggly line under it, and will not receive the syntax
 colour that valid tags do.
 
-The tag is the only part of these notes that the novelWriter uses. The rest of the document content
+The tag is the only part of these notes that novelWriter uses. The rest of the document content is
-is there for the writer to use in whatever way they wish. Of course, the content of the documents
+there for you to use in whatever way you wish. Of course, the content of the documents can be added
-can be added to the manuscript, or an outline document. If you want to compile a single document of
+to the manuscript, or an outline document. If you want to compile a single document of all your
-all your notes, you can do this from the :guilabel:`Manuscript Build` tool.
+notes, you can do this from the :guilabel:`Manuscript Build` tool.
 
 Example of a heading with a tag for a character of the story:
 
@@ -81,10 +80,13 @@ Example of a heading with a tag for a character of the story:
 
 When this is done in a document in a :term:`Root Folder` of type "Characters", the tag is
 automatically treated as an available character in your project, and you will be able to reference
-it in any of your other documents using the reference keywords for characters.
+it in any of your other documents using the reference keywords for characters. It will also show up
+in the Character tab in the Reference panel below the document viewer, and in the reference
+auto-completer menu in the editor when you fill in references. See :ref:`a_ui_view` and
+:ref:`a_references_completer`.
 
 It is the root folder type that defines what category of story elements the tag is indexed under.
-See the :ref:`a_proj_roots` section for an overview of availabe root folder types. They are also
+See the :ref:`a_proj_roots` section for an overview of available root folder types. They are also
 covered in the next section.
 
 
@@ -148,6 +150,12 @@ that the tags referenced exist.
    In general, the index for a document is regenerated when it is saved, so this shouldn't normally
    be necessary.
 
+.. tip::
+   If you add a reference in the editor to a tag that doesn't yet exist, you can right-click it and
+   select :guilabel:`Create Note for Tag`. This will generate a new project note automatically with
+   the new tag defined. In order for this to be possible, a root folder for that category of
+   references must already exist.
+
 One note can also reference another note in the same way novel documents do. When the note is
 opened in the document viewer, the references become clickable links, making it easier to follow
 connections in the plot. You can follow links in the document editor by clicking them with the
@@ -176,3 +184,19 @@ Example of a novel document with references to characters and plots:
    @plot: Main
 
    Once upon a time ...
+
+
+.. _a_references_completer:
+
+The References Auto-Completer
+-----------------------------
+
+An auto-completer context menu will show up automatically in the document editor when you type the
+character ``@`` on a new line. It will first suggest tag or reference keywords for you to add, and
+after the ``:`` has been added, suggest references from the list of tags you have already defined.
+
+You can use the auto-completer to add multiple references with a ``,`` between them, and even type
+new ones. New references can be created by right-clicking on them and selecting
+:guilabel:`Create Note for Tag` from the menu.
+
+.. versionadded:: 2.2

docs/source/usage_breakdown.rst

@@ -23,6 +23,7 @@ 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
 clutter, and since the documents are formatted with style tags, it is more or less redundant.
+
 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
 them. For reference, a list of all shortcuts can be found in the :ref:`a_kb` chapter.
@@ -36,13 +37,18 @@ On the left side of the main window, you will find a sidebar. This bar has butto
 views you can switch between, a quick link to the :guilabel:`Build Manuscript` tool, and a set of
 project-related tools and quick access to settings at the bottom.
 
+.. versionadded:: 2.2
+   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,
+   but can be opened by pressing the three dots icon in the top right corner.
 
-Project Tree View
+
------------------
+Project Tree and Editor View
+----------------------------
 
 .. figure:: images/fig_project_tree_view.png
 
-   A screenshot of the Project Tree View.
+   A screenshot of the Project Tree and Editor View.
 
 When in :guilabel:`Project Tree View` mode, the main work area of the main window is split in two,
 or optionally three, panels. The left-most panel contains the project tree and all the documents in
@@ -59,8 +65,8 @@ the editor's header, or by pressing :kbd:`F8`. When :guilabel:`Focus Mode` is en
 interface elements other than the document editor itself are hidden away.
 
 
-Novel Tree View
+Novel Tree and Editor View
----------------
+--------------------------
 
 .. figure:: images/fig_novel_tree_view.png
 
@@ -134,7 +140,7 @@ This is a brief introduction to how you structure your writing projects. All of
 covered in more detail later.
 
 The main point of novelWriter is that you are free to organise your project documents as you wish
-into subfolders or subdocuments, and split the text between these documents in whatever way suits
+into sub-folders or sub-documents, and split the text between these documents in whatever way suits
 you. All that matters to novelWriter is the linear order the documents appear at in the project
 tree (top to bottom). The chapters, scenes and sections of the novel are determined by the headings
 within those documents.
@@ -153,8 +159,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.
 
 This header level structure is only taken into account for :term:`novel documents`. For
-:term:`project notes`, the header levels have no structural meaning, and the user is free to do
+:term:`project notes`, the header levels have no structural meaning, and you are free to use them
-whatever they 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
    You can add documents as child items of other documents. This is often more useful than adding
@@ -173,8 +179,9 @@ The project can at any time be assembled into a range of different formats throu
 various flavours of Markdown.
 
 The HTML5 format is suitable for conversion by a number of other tools like Pandoc_, or for
-importing into word processors if the Open Document format isn't suitable. In addition, printing
+importing into word processors if the Open Document format isn't suitable. The Open Document format
-is also possible. Print to PDF is available from the print dialog.
+is supported by most Office type applications. In addition, printing is also possible. Print to PDF
+is available from the print dialog.
 
 In addition, you can export the content of the project to a JSON file. This is useful if you want
 to write your own custom processing script in for instance Python, as the entire novel can be read

docs/source/usage_format.rst

@@ -7,7 +7,8 @@ Formatting Your Text
 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
 *not* a Markdown editor. It supports basic formatting like emphasis (italic), strong importance
-(bold) and strikethrough text, as well as four levels of headings.
+(bold) and strike through text, as well as four levels of headings. Form some further complex
+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
 keyword and value sets used for :term:`tags<tag>` and :term:`references<reference>`. There are also
@@ -20,7 +21,7 @@ Syntax Highlighting
 ===================
 
 The editor has a syntax highlighter feature that is meant to help you know when you've used the
-formtatting tags or other features correctly. It will change the colour and font size of your
+formatting tags or other features correctly. It will change the colour and font size of your
 headings, change the text colour of emphasised text, and it can also show you where you have
 dialogue in your text.
 
@@ -94,7 +95,7 @@ A text paragraph is indicated by a blank line. That is, you need two line breaks
 fragments of text into two paragraphs. Single line breaks are treated as line breaks within a
 paragraph.
 
-In addition, the editor supports a few additional types of whitespaces:
+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`.
 * Thin spaces are also supported, and can be inserted with :kbd:`Ctrl+K`, :kbd:`Shift+Space`.
@@ -126,7 +127,7 @@ A minimal set of text emphasis styles are supported for text paragraphs.
    The text is rendered as strongly important text (bold).
 
 ``~~text~~``
-   Strikethrough text.
+   Strike through text.
 
 In Markdown guides it is often recommended to differentiate between strong importance and emphasis
 by using ``**`` for strong and ``_`` for emphasis, although Markdown generally also supports ``__``
@@ -136,8 +137,8 @@ recommendation.
 
 In addition, the following rules apply:
 
-1. The emphasis and strikethrough formatting tags do not allow spaces between the words and the tag
+1. The emphasis and strike through formatting tags do not allow spaces between the words and the
-   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
    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*
@@ -146,7 +147,7 @@ In addition, the following rules apply:
 4. Text emphasis does not span past line breaks. If you need to add emphasis to multiple lines or
    paragraphs, you must apply it to each of them in turn.
 5. Text emphasis can only be used in plain paragraphs. Comments, titles, and meta data tags don't
-   allow for formatting, and any formatting markup will be renderred as-is.
+   allow for formatting, and any formatting markup will be rendered as-is.
 
 .. tip::
    novelWriter supports standard escape syntax for the emphasis markup characters in case the
@@ -155,6 +156,39 @@ In addition, the following rules apply:
    markup.
 
 
+.. _a_fmt_shortcodes:
+
+Extended Formatting with Shortcodes
+===================================
+
+For additional formatting options, you can use shortcodes. Shortcodes is a form of in-line codes
+that can be used to change the format of the text that follows and opening code, and last until
+that formatting region is ended with a closing code.
+
+These shortcodes are intended for special formatting cases, or more complex cases that cannot be
+solved with simple Markdown-like formatting codes. Available shortcodes are listed below.
+
+.. csv-table:: Shortcodes Formats
+   :header: "Syntax", "Description"
+   :widths: 40, 60
+   :class: "tight-table"
+
+   "``[b]text[/b]``",     "Text is rendered as bold text."
+   "``[i]text[/i]``",     "Text is rendered as italicised text."
+   "``[s]text[/s]``",     "Text is rendered as strike through text."
+   "``[u]text[/u]``",     "Text is rendered as underlined text."
+   "``[sup]text[/sup]``", "Text is rendered as superscript text."
+   "``[sub]text[/sub]``", "Text is rendered as subscript text."
+
+Unlike Markdown style codes, these can be used anywhere within a paragraph. Even in the middle of a
+word if you need to. You can also freely combine them to form more complex formatting.
+
+The shortcodes are available from the :guilabel:`Format` menu and in the editor toolbar, which can
+be activated by clicking the three dots in the editor header.
+
+.. versionadded:: 2.2
+
+
 .. _a_fmt_comm:
 
 Comments and Synopsis
@@ -169,19 +203,25 @@ in a special manner and will show up in the :ref:`a_ui_outline` in a dedicated c
 ``synopsis`` is not case sensitive. If it is correctly formatted, the syntax highlighter will
 indicate this by altering the colour of the word.
 
-``% text...``
+``% text ...``
    This is a comment. The text is not rendered by default (this can be overridden), seen in the
    document viewer, or counted towards word counts.
 
-``% Synopsis: text...``
+``%Synopsis: text ...``
    This is a synopsis comment. It is generally treated in the same way as a regular comment, except
    that it is also captured by the indexing algorithm and displayed in the :ref:`a_ui_outline`. It
    can also be filtered separately when building the project to for instance generate an outline
    document of the whole project.
 
+``%Short: text ...``
+   This is a short description comment. It is identical to the synopsis comment, but is intended to
+   be used for project notes. The text shows up in the Reference panel below the document viewer in
+   the last column labelled :guilabel:`Short Description`.
+
 .. note::
-   Only one comment can be flagged as a synopsis comment for each heading. If multiple comments are
+   Only one comment can be flagged as a synopsis or short comment for each heading. If multiple
-   flagged as synopsis comments, the last one will be used and the rest ignored.
+   comments are flagged as synopsis or short comments, the last one will be used and the rest
+   ignored.
 
 
 .. _a_fmt_tags:
@@ -204,8 +244,9 @@ References are in the form:
 ``@keyword: value``
    A reference keyword followed by a value, or a comma separated list of values.
 
-Tags andreferences are covered in detail in the :ref:`a_references` chapter. The keywords can be
+Tags and references are covered in detail in the :ref:`a_references` chapter. The keywords can be
-inserted at the cursor position in the editor via the :guilabel:`Insert` menu.
+inserted at the cursor position in the editor via the :guilabel:`Insert` menu. If you start typing
+an ``@`` on a new line, and auto-complete menu will also pop up suggesting keywords.
 
 
 .. _a_fmt_align:

docs/source/usage_project.rst

@@ -28,7 +28,7 @@ the project, and has four columns.
 
 **Column 2**
    The second column shows the word count of the document, or the sum of words of the child items
-   for folders and documents with subdocuments. If the counts seem incorrect, they can be updated
+   for folders and documents with sub-documents. If the counts seem incorrect, they can be updated
    by rebuilding the :term:`project index` from the :guilabel:`Tools` menu, or by pressing
    :kbd:`F9`.
 
@@ -62,6 +62,11 @@ Below the project tree you will find a small details panel showing the full info
 currently selected item. This panel also includes the latest paragraph and character counts in
 addition to the word count.
 
+.. tip::
+   If you want to set the label of a document to be the same as a header within it, you can
+   right-click a header in the document when it is open in the editor and select
+   :guilabel:`Set as Document Name` from the context menu.
+
 
 .. _a_ui_tree_split_merge:
 
@@ -73,6 +78,7 @@ will find several options on how to change a document or folder. This includes c
 document and note, but also splitting them into multiple documents, or merging child items into a
 single document.
 
+
 Splitting Documents
 ^^^^^^^^^^^^^^^^^^^
 
@@ -91,6 +97,7 @@ hierarchy of documents. That is, put sections under scenes, and scenes under cha
 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.
 
+
 Merging Documents
 ^^^^^^^^^^^^^^^^^
 
@@ -137,10 +144,14 @@ The project tree allows drag & drop to a certain extent to allow you to reorder
 folders. Moving a document in the project tree will affect the text's position when you assemble
 your manuscript in the :guilabel:`Manuscript Build` tool.
 
-Drag & drop has only limited support for moving documents. In general, bulk actions are not
+.. versionadded:: 2.2
-allowed. This is deliberate to avoid accidentally messing up your project. If you make a mistake,
+   You can now select multiple items in the project tree by holding down the :kbd:`Ctrl` or
-the last move action can be undone by pressing :kbd:`Ctrl+Shift+Z` or from the menu icon in the
+   :kbd:`Shift` key while selecting items.
-project tree's toolbar.
+
+You can drag and drop documents and regular folders, but not root folders. If you select multiple
+items, they can only be dragged and dropped if they are siblings. That is, they have the same
+parent item in the project. This is due to the way drag and drop is implemented in the user
+interface framework novelWriter is built upon.
 
 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
@@ -149,8 +160,8 @@ folder, its "Importance" setting will be switched with a "Status" setting. See
 :ref:`a_ui_tree_status`. The old value will not be overwritten though, and should be restored if
 you move it back at some point.
 
-Root folders in the project tree cannot be dragged & 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 eachother 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.
 
 

docs/source/usage_shortcuts.rst

@@ -104,7 +104,7 @@ Text Formatting Shortcuts
    ":kbd:`Ctrl+8`",       "Add a left 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+D`",       "Strikethrough selected text, or word under cursor"
+   ":kbd:`Ctrl+D`",       "Strike through selected text, or word under cursor"
    ":kbd:`Ctrl+I`",       "Format selected text, or word under cursor, with emphasis (italic)"
    ":kbd:`Ctrl+Shift+/`", "Remove block formatting for block under cursor"
 

docs/source/usage_typography.rst

@@ -61,7 +61,7 @@ Single and Double Prime
 Both single and double prime symbols are available in the :guilabel:`Insert` menu. These symbols
 are the correct symbols to use for unit symbols for feet, inches, minutes, and seconds. The usage
 of these is described in more detail on the Wikipedia Prime_ page. They look very similar to single
-and double straight quotes, and may be renderred similarly by the font, but they have different
+and double straight quotes, and may be rendered similarly by the font, but they have different
 codes. Using these correctly will also prevent the auto-replace and dialogue highlighting features
 misunderstanding their meaning in the text.
 
@@ -74,7 +74,7 @@ even if it is intended as an apostrophe. This also includes the syntax highlight
 assume the first following apostrophe is the closing symbol of a single quoted region of text.
 
 To get around this, an alternative apostrophe is available. It is a special Unicode character that
-is not categorised as punctuation, but as a modifier. It is usually renderred the same way as the
+is not categorised as punctuation, but as a modifier. It is usually rendered the same way as the
 right single quotation marks, depending on the font. There is a Wikipedia article for the
 `Modifier letter apostrophe`_ with more details.
 

docs/source/usage_writing.rst

@@ -24,9 +24,8 @@ Markdown-like syntax for some features, and a novelWriter-specific syntax for ot
 format is described in the :ref:`a_fmt` chapter.
 
 The editor has a maximise button (toggles the :guilabel:`Focus Mode`) and a close button in the
-top--right corner. On the top--left side you will find an edit button that opens the
+top--right corner. On the top--left side you will find a tools button that opens a toolbar with a
-:guilabel:`Item Label` dialog for the currently open document, and a search button to open the
+few buttons for applying text formatting, and a search button to open the search dialog.
-search dialog.
 
 Both the document editor and viewer will show the label of the currently open document in the
 header at the top of the edit or view panel. Optionally, the full project path to the document can
@@ -40,6 +39,18 @@ Any :term:`references<reference>` in the editor can be opened in the viewer by m
 the label and pressing :kbd:`Ctrl+Return`. You can also control-click them with your mouse.
 
 
+Editor Auto-Completer
+---------------------
+
+If you type the character ``@`` on a new line, a context menu will appear showing the different
+available keywords. The list will shorten as you type. Once a keyword command has been selected or
+typed, the editor may suggest further content based on your project content. See
+:ref:`a_references_completer` for more details.
+
+.. versionadded:: 2.2
+   The auto-completer feature was added.
+
+
 .. _a_ui_view:
 
 Viewing a Document
@@ -68,11 +79,10 @@ buttons, these can be used as well. They work just like the backward and forward
 browser.
 
 At the bottom of the view panel there is a :guilabel:`References` panel. (If it is hidden, click
-the icon next to it to reveal it.) This panel will show links to all documents referring back to
+the button on the left side of the footer area to reveal it.) This panel contains a References tab
-the one you're currently viewing, if any has been defined. The :guilabel:`Sticky` button will
+with links to all documents referring back to the one you're currently viewing, if any has been
-freeze the content of the panel to the current document, even if you navigate to another document.
+defined. If you have created root folders and tags for various story elements like characters and
-This is convenient if you want to quickly look through all documents in the list in the
+plot points, these will appear as additional tabs in this panel.
-:guilabel:`References` panel without losing the list in the process.
 
 .. note::
    The :guilabel:`References` panel relies on an up-to-date :term:`index<project index>` of the
@@ -80,6 +90,9 @@ This is convenient if you want to quickly look through all documents in the list
    the index can always be rebuilt by selecting :guilabel:`Rebuild Index` from the
    :guilabel:`Tools` menu, or by pressing :kbd:`F9`.
 
+.. versionadded:: 2.2
+   The reference panel was redesigned and the additional tabs added.
+
 
 .. _a_ui_edit_search: