Move more docs into new structure

docs/source/user_interface/editor_viewer.rst

@@ -0,0 +1,199 @@
+.. _docs_ui_edit_view:
+
+*********************
+The Editor and Viewer
+*********************
+
+.. _Compose Key: https://en.wikipedia.org/wiki/Compose_key
+
+This chapter covers in more detail how the document editor and viewer panels work.
+
+
+.. _docs_ui_edit_view_edit:
+
+Editing a Document
+==================
+
+.. figure:: images/fig_editor.png
+
+   A screenshot of the Document Editor panel.
+
+To edit a document, double-click it in the project tree, press the :kbd:`Return` key while having
+it selected, or drag and drop it onto the editor panel. This will open the document in the document
+editor. The editor uses a Markdown-like syntax for some features, and a novelWriter-specific syntax
+for others.
+
+The editor has a maximise button, which toggles the **Focus Mode**, and a close button in the
+top--right corner. On the top--left side you will find a tools button that opens a toolbar with a
+few buttons for applying text formatting, a drop down menu for navigating between headings, and a
+search button to open the 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
+be shown. This can be set in **Preferences**.
+
+.. tip::
+
+   Clicking on the document title bar will select the document in the project tree and thus reveal
+   its location there, making it easier to find in a large project.
+
+Any references in the editor can be opened in the viewer by moving the cursor to
+the label and pressing :kbd:`Ctrl+Return`. You can also control-click them with your mouse.
+
+
+Spell Checking
+--------------
+
+A third party library called Enchant is used for spell checking in the editor. The controls for
+spell checking can be found in the **Tools** menu. You can also set spell checking language in
+**Project Settings**.
+
+This spell checking library comes with support for custom words that you can add by selecting
+"Add Word to Dictionary" from the context menu when a word is highlighted by the spell checker as
+misspelled. The custom words are managed on a per-project basis, and can the list of words can be
+edited from the **Project Word List** tool available from the **Tools** menu.
+
+.. note::
+
+   Generally, spell checking dictionaries are collected from your operating system, but on Windows
+   they are not. See :ref:`docs_more_custom_dict` for how to add spell checking dictionaries on Windows.
+
+
+.. versionadded:: 2.2
+
+
+Word Counts
+-----------
+
+A character, word and paragraph count is maintained for each document, as well as for each section
+of a document following a heading. The word count and change of words in the current session is
+displayed in the footer of any document open in the editor, and all stats are shown in the details
+panel below the project tree for any document selected in the project or novel trees.
+
+The word counts are not updated in real time, but run in the background every few seconds for as
+long as the document is being actively edited.
+
+A total project word count is displayed in the status bar. The total count depends on the sum of
+the values in the project tree, which again depend on an up to date project index. If the
+counts seem wrong, a full project word recount can be initiated by rebuilding the project's index.
+Either from the **Tools** menu, or by pressing :kbd:`F9`.
+
+The rules for how the counts are made is covered in more detail in :ref:`docs_more_counting`.
+
+
+.. _docs_ui_edit_view_view:
+
+Viewing a Document
+==================
+
+.. figure:: images/fig_viewer.png
+
+   A screenshot of the Document Viewer panel.
+
+Any document in the project tree can also be viewed in parallel in a right hand side document
+viewer. To view a document, press :kbd:`Ctrl+R`, select **View Document** in the menu or context
+menu, or drag and drop the document onto the viewer panel. If you have a middle mouse button,
+middle-clicking on the document will also open it in the viewer.
+
+The document viewed does not have to be the same document as the one currently being edited.
+However, If you *are* viewing the same document, pressing :kbd:`Ctrl+R` from the editor will update
+the document with your latest changes. You can also press the reload button in the top--right
+corner of the viewer panel, next to the close button, to achieve the same thing.
+
+In the viewer  `references<reference>` become clickable links. Clicking them will replace the
+content of the viewer with the content of the document the reference points to.
+
+The document viewer keeps a history of viewed documents, which you can navigate with the arrow
+buttons in the top--left corner of the viewer. If your mouse has backward and forward navigation
+buttons, these can be used as well. They work just like the backward and forward features in a
+browser. The left-most button is a dropdown menu for quickly navigation between headings in the
+document. The edit button on the right will open the viewed document in the editor.
+
+At the bottom of the view panel there is a **References** panel. (If it is hidden, click the button
+on the left side of the footer area to reveal it.) This panel contains a References tab with links
+to all documents referring back to the one you're currently viewing, if any has been defined. If
+you have created root folders and tags for various story elements like characters and plot points,
+these will appear as additional tabs in this panel.
+
+.. note::
+
+   The **References** panel relies on an up-to-date  `index<project index>` of the project.
+   The index is maintained automatically. However, if anything is missing, or seems wrong, the
+   index can always be rebuilt by selecting **Rebuild Index** from the **Tools** menu, or by
+   pressing :kbd:`F9`.
+
+.. versionadded:: 2.2
+
+   The reference panel was redesigned and the additional tabs added.
+
+
+.. _docs_ui_edit_view_search:
+
+Search & Replace
+================
+
+.. figure:: images/fig_editor_search.png
+
+   A screenshot of the Document Editor search box.
+
+The document editor has a search and replace tool that can be activated with :kbd:`Ctrl+F` for
+search mode or :kbd:`Ctrl+H` for search and replace mode.
+
+Pressing :kbd:`Return` while in the search box will search for the next occurrence of the word, and
+:kbd:`Shift+Return` for the previous. Pressing :kbd:`Return` in the replace box, will replace the
+highlighted text and move to the next result.
+
+There are a number of settings for the search tool available as toggle switches above the search
+box. They allow you to search for, in order: matched case only, whole word results only, search
+using regular expressions, loop search when reaching the end of the document, and move to the next
+document when reaching the end. There is also a switch that will try to match the case of the word
+when the replacement is made. That is, it will try to keep the word upper, lower, or capitalised to
+match the word being replaced.
+
+.. seealso::
+
+   For more information on the capabilities of the Regular Expression option, see the Qt
+   documentation for the `QRegularExpression <https://doc.qt.io/qt-6/qregularexpression.html>`_
+   class.
+
+
+.. _docs_ui_edit_view_auto:
+
+Auto-Replace as You Type
+========================
+
+A few auto-replace features are supported by the editor. You can control every aspect of the
+auto-replace feature from **Preferences**. You can also disable this feature entirely if you wish.
+
+.. tip::
+
+   If you don't like auto-replacement, all symbols inserted by this feature are also available in
+   the :guilabel:`Insert` menu, and via :ref:`docs_features_shortcuts_insert`. You may also be
+   using a `Compose Key`_ setup, which means you may not need the auto-replace feature at all.
+
+The editor is able to replace two and three hyphens with short and long dashes, triple points with
+ellipsis, and replace straight single and double quotes with user-defined quote symbols. It will
+also try to determine whether to use the opening or closing symbol, although this feature isn't
+always accurate. Especially distinguishing between closing single quote and apostrophe can be
+tricky for languages that use the same symbol for these, like English does.
+
+.. tip::
+
+   If the auto-replace feature changes a symbol when you did not want it to change, pressing
+   :kbd:`Ctrl+Z` once after the auto-replacement will undo it without undoing the character
+   you typed before it.
+
+
+.. _docs_ui_edit_view_dialogue:
+
+Dialogue Highlighting
+=====================
+
+The editor and viewer can optionally highlight character dialogue in your novel documents. By
+default, this feature is set to display text in double quotes as dialogue. In **Preferences**, you
+can change this to support various other dialogue markers that instead uses dashes to indicate
+dialogue, like those used in Spanish, Portuguese, Polish, etc.
+
+Various styles are supported by changing the settings under "Text Highlighting" in **Preferences**.
+
+It is also possible to include the dialogue highlighting in your manuscripts.

docs/source/user_interface/projects.rst

@@ -0,0 +1,143 @@
+.. _docs_ui_projects:
+
+*****************
+Managing Projects
+*****************
+
+Your text in novelWriter is organised into projects. Each project is meant to contain one novel
+and associated notes. If you have multiple novels in a series, with the same characters and shared
+notes, it is also possible to keep all of them in the same project by creating multiple **Novel**
+root folders. See :ref:`docs_usage_project_roots` for more details.
+
+
+.. _docs_ui_projects_new:
+
+Creating A New Project
+======================
+
+You can create a new project from the **Project** menu by selecting **Create or Open Project**.
+This will open the **Welcome** dialog, where you can select the :guilabel:`New` button that will
+assist you in creating a project. This dialog is also displayed when you start novelWriter.
+
+A novelWriter project requires a dedicated folder for storing its files on the local file system.
+If you're interested in the details, you can have a look at the section
+:ref:`docs_technical_storage`.
+
+A list of recently opened projects is maintained, and displayed in the **Welcome** dialog. A
+project can be removed from this list by selecting it and pressing the :kbd:`Del` key or by
+right-clicking it and selecting the **Remove Project** option.
+
+.. figure:: images/fig_welcome.jpg
+
+   The project list (left) and new project form (right) of the **Welcome** dialog.
+
+Project-specific settings are available in **Project Settings** in the **Project** menu. See
+further details below in the :ref:`docs_ui_projects_settings` section.
+
+Details about the project's novel text, including word counts, and a table of contents with word
+and page counts, is available through the **Novel Details** dialog. Statistics about the project
+is also available in the **Manuscript Build** tool.
+
+
+Template Projects
+-----------------
+
+From the Welcome dialog you can also create a new from another existing project. If you have a
+specific structure you want to use for all your new projects, you can create a dedicated project to
+be used as a template, and select to copy an existing project from the :guilabel:"Prefill Project"
+option from the **New Project** form.
+
+
+.. _docs_ui_projects_settings:
+
+Project Settings
+================
+
+The **Project Settings** can be accessed from the **Project** menu, or by pressing
+:kbd:`Ctrl+Shift+,`. This will open a dialog box, with a set of tabs.
+
+
+Settings Tab
+------------
+
+The **Settings** tab holds the project name, author, and language settings.
+
+The **Project Name** can be edited here. It is used for the main window title and for generating
+backup files. So keep in mind that if you do change this setting, the backup file names will change
+too.
+
+You can also change the **Authors** and **Project Language** setting. These are only used when
+building the manuscript, for some formats. The language setting is also used when inserting text
+into documents in the viewer, like for instance labels for keywords and special comments.
+
+If your project is in a different language than your main spell checking language is set to, you
+can override the default setting here. The project language can also be changed from the **Tools**
+menu.
+
+You can also override the automatic backup setting for the project if you wish.
+
+
+Status and Importance Tabs
+--------------------------
+
+Each document or folder of type **Novel** can be given a "Status" label accompanied by a coloured
+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
+other features to work. No other part of novelWriter accesses this information. The intention is to
+use these to indicate at what stage of completion each novel document is, or how important the
+content of a note is to the story. You don't have to use them this way, that's just what they were
+intended for, but you can make them whatever you want.
+
+Both status and importance labels can be exported and imported so you can share them between
+projects, or define a standard set for all your writing projects. When you import labels to a
+project, they are always added as *new* labels.
+
+See also :ref:`a_ui_tree_status`.
+
+.. note::
+
+   The status or importance level currently in use by one or more documents cannot be deleted, but
+   they can be edited.
+
+
+Auto-Replace Tab
+----------------
+
+A set of automatically replaced keywords can be added in this tab. The keywords in the left column
+will be replaced by the text in the right column when documents are opened in the viewer. They will
+also be applied to manuscript builds.
+
+The auto-replace feature will replace text in angle brackets that is in this list. The syntax
+highlighter will add an alternate colour to text matching the syntax, but it doesn't check if the
+text is in this list.
+
+.. note::
+   A keyword cannot contain spaces. The angle brackets are added by default, and when used in the
+   text are a part of the keyword to be replaced. This is to ensure that parts of the text aren't
+   unintentionally replaced by the content of the list.
+
+
+.. _docs_ui_projects_backup:
+
+Backup
+======
+
+An automatic backup system is built into novelWriter. In order to use it, a backup path to where
+the backup files are to be stored must be provided in **Preferences**. The path defaults to a
+folder named "Backups" in your home directory.
+
+Backups can be run automatically when a project is closed, which also implies it is run when the
+application itself is closed. Backups are date stamped zip files of the project files in the
+project folder (files not strictly a part of the project are ignored). The zip archives are stored
+in a subfolder of the backup path. The subfolder will have the same name as the **Project Name** as
+defined in :ref:`docs_ui_projects_settings`.
+
+The backup feature, when configured, can also be run manually from the **Tools** menu. It is also
+possible to disable automated backups for a given project in **Project Settings**.
+
+.. note::
+   For the backup to be able to run, the **Project Name** must be set in **Project Settings**. This
+   value is used to generate the name and path of the backups. Without it, the backup will not run
+   at all, but it will produce a warning message.

docs/source/user_interface/split_and_merge.rst

@@ -0,0 +1,48 @@
+.. _docs_ui_split_merge:
+
+*************************
+Split and Merge Documents
+*************************
+
+Under the **Transform** submenu in the context menu of an item in the project tree, you will find
+several options on how to change a document or folder. This includes changing between document and
+note, but also splitting them into multiple documents, or merging child items into a single
+document.
+
+
+Splitting Documents
+===================
+
+.. figure:: images/fig_project_split_tool.png
+
+   The **Split Document** dialog.
+
+The **Split Document by Headings** 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 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.
+
+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.
+
+The source document **is not** deleted in the process, but you have the option to let the tool move
+the source document to the **Trash** folder.
+
+
+Merging Documents
+=================
+
+.. figure:: images/fig_project_merge_tool.png
+
+   The **Merge Documents** dialog.
+
+You have two options for merging documents that are child elements of another document. You can
+either **Merge Child Items into Self** and **Merge Child Items into New**. The first option will
+pull all content of child items and merge them into the parent document, while the second option
+will create a new document in the process.
+
+When merging documents in a folder, you only have the latter process is possible, so only the
+choice **Merge Documents in Folder** is available.
+
+In either case, the **Merge Documents** dialog will let you exclude documents you don't want to
+include, and it also lets you reorder them if you wish.

docs/source/user_interface/statistics.rst

@@ -0,0 +1,38 @@
+.. _docs_ui_statistics:
+
+******************
+Writing Statistics
+******************
+
+When you work on a project, a log file records when you opened it, when you closed it, and the
+total word counts of your novel documents and notes at the end of the session, provided that the
+session lasted either more than 5 minutes, or that the total word count changed. For more details
+about the log file, see :ref:`docs_technical_storage`.
+
+A tool to view the content of the log file is available in the **Tools** menu under **Writing
+Statistics**. You can also launch it by pressing :kbd:`F6`, or find it on the sidebar.
+
+The tool will show a list of all your sessions, and a set of filters to apply to the data. You can
+also export the filtered data to a JSON file or to a CSV file that can be opened by a spreadsheet
+application like for instance Libre Office Calc or Excel.
+
+.. versionadded:: 1.2
+
+   As of version 1.2, the log file also stores how much of the session time was spent idle. The
+   definition of idle here is that the novelWriter main window loses focus, or the user hasn't made
+   any changes to the currently open document in five minutes. The number of minutes can be altered
+   in **Preferences**.
+
+
+Session Timer
+=============
+
+A session timer is by default visible in the status bar. The icon will show you a clock icon when
+you are active, and a pause icon when you are considered "idle" per the criteria mentioned above.
+
+If you do not wish to see the timer, you can click on it once to hide it. The icon will still be
+visible. Click the icon once more to display the timer again.
+
+.. versionadded:: 2.6
+
+   As of version 2.6, clicking the timer text or icon in the status bar will toggle its visibility.