diff --git a/docs/source/_outtakes.rst b/docs/source/_outtakes.rst deleted file mode 100644 index ac67e044..00000000 --- a/docs/source/_outtakes.rst +++ /dev/null @@ -1,10 +0,0 @@ -From Index ----------- - -The project storage is suitable for version control software, and also well suited for file -synchronisation tools. All text is saved as plain text files, and your project data as standard -data formats in XML and JSON. See :ref:`a_storage` for more details. - -Any operating system that has Python 3 and the Qt 6 libraries should be able to run novelWriter. -It runs fine on Linux, Windows and MacOS, and users have tested it on other platforms as well. -See :ref:`a_started` for more details. diff --git a/docs/source/images/fig_story_structure_manuscript.png b/docs/source/features/images/fig_story_structure_manuscript.png similarity index 100% rename from docs/source/images/fig_story_structure_manuscript.png rename to docs/source/features/images/fig_story_structure_manuscript.png diff --git a/docs/source/writing_story.rst b/docs/source/features/story_structure.rst similarity index 99% rename from docs/source/writing_story.rst rename to docs/source/features/story_structure.rst index ba6b9641..c64b00a6 100644 --- a/docs/source/writing_story.rst +++ b/docs/source/features/story_structure.rst @@ -1,4 +1,4 @@ -.. _a_story_structure: +.. _docs_features_story: ************************ Story Structure Comments diff --git a/docs/source/index.rst b/docs/source/index.rst index 0041d168..91154b61 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -61,17 +61,31 @@ storage for robustness. features/introduction features/shortcuts features/breaks_and_spaces + features/story_structure .. toctree:: :maxdepth: 1 - :caption: Introduction + :caption: Special Topics :hidden: - int_introduction - int_overview - int_started - int_howto - int_glossary + more/howto + more/counting + more/typography + more/customise + more/project_format + +.. toctree:: + :maxdepth: 1 + :caption: Technical Topics + :hidden: + + technical/locations + technical/storage + technical/source + technical/tests + + + .. toctree:: :maxdepth: 1 @@ -81,9 +95,7 @@ storage for robustness. usage_breakdown usage_project usage_writing - usage_format usage_shortcuts - usage_typography .. toctree:: :maxdepth: 1 @@ -92,31 +104,4 @@ storage for robustness. project_overview project_structure - project_references project_manuscript - -.. toctree:: - :maxdepth: 1 - :caption: Writing Aids - :hidden: - - writing_story - -.. toctree:: - :maxdepth: 1 - :caption: Additional Details - :hidden: - - more_customise - more_projectformat - more_counting - -.. toctree:: - :maxdepth: 1 - :caption: Technical Topics - :hidden: - - tech_locations - tech_storage - tech_source - tech_tests diff --git a/docs/source/int_glossary.rst b/docs/source/int_glossary.rst deleted file mode 100644 index c8777923..00000000 --- a/docs/source/int_glossary.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. _a_glossary: - -******** -Glossary -******** - -.. glossary:: - :sorted: - - Root Folder - A "Root Folder" is a top level folder of the project tree in novelWriter. Each type of root - folder has a specific icon to identify it. For an overview of available root folder types, - see :ref:`a_proj_roots`. - - Novel Documents - These are documents that are created under a "Novel" :term:`Root Folder`. They behave - differently than :term:`Project Notes`, and have some more restrictions. For instance, they - can not exist in folders intended only for project notes. See the :ref:`a_struct` chapter for - more details. - - Project Notes - Project Notes are unrestricted documents that can be placed anywhere in your project. You - should not use these documents for story elements, only for notes. Project notes are the - source files used by the Tags and References system. See the :ref:`a_references` chapter for - more details on how to use them. - - Tag - A tag is a user defined value assigned as a tag to a section of your :term:`Project Notes`. - It is optional, and can be defined once per heading. It is set using the :term:`keyword` - syntax ``@tag: value``, where ``value`` is the user defined part. Each tag can be referenced - in another file using one of the :term:`reference` keywords. See :ref:`a_references` chapter - for more details. - - Reference - A reference is one of a set of :term:`keywords` that can be used to link to a - :term:`tag` in another document. The reference keywords are specific to the different - :term:`root folder` types. A full overview is available in the :ref:`a_references` chapter. - - Project Index - The project index is a record of all headings in a project, with all their meta data like - synopsis comments, :term:`tags` and :term:`references`. The project index is - kept up to date automatically, but can also be regenerated manually from the - :guilabel:`Tools` menu or by pressing :kbd:`F9`. - - Context Menu - A context menu is a menu that pops up when you right click something in the user interface. - In novelWriter, you can often also open a context menu by pressing the keyboard shortcut - :kbd:`Ctrl+.`. - - Headings - Each level of headings in :term:`Novel Documents` have a specific meaning in terms of the - structure of the story. That is, they determine what novelWriter considers a partition, a - chapter, a scene or a text section. For :term:`Project Notes`, the heading levels don't - matter. For more details on headings in novel documents, see :ref:`a_struct_heads`. - - Keyword - A keyword in novelWriter is a special command you put in the text of your documents. They are - not standard Markdown, but are used in novelWriter to add information that is interpreted by - the application. For instance, keywords are used for :term:`tags` and - :term:`references`. - - Keywords must always be on their own line, and the first character of the line must always be - the ``@`` character. The keyword must also always be followed by a ``:`` character, and the - values passed to the command are added after this, separated by commas. diff --git a/docs/source/int_introduction.rst b/docs/source/int_introduction.rst deleted file mode 100644 index 23cefcc6..00000000 --- a/docs/source/int_introduction.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. _a_intro: - -******** -Overview -******** - -.. _Snowflake: https://www.advancedfictionwriting.com/articles/snowflake-method/ -.. _Markdown: https://en.wikipedia.org/wiki/Markdown - - - -Your novel project in novelWriter is organised as a collection of separate plain text documents -instead of a single, large document. The idea is to make it easier to reorganise your project -structure without having to cut and paste text between chapters and scenes. - -There are two kinds of documents in your project: :term:`Novel Documents` are documents that are -part of your story. The other kind of documents are :term:`Project Notes`, which are intended for -your notes about your characters, your world building, and so on. - -You can at any point split the individual documents by their headings up into multiple documents, -or merge multiple documents into a single document. This makes it easier to use variations of the -Snowflake_ method for writing. You can start by writing larger structure-focused documents, like -for instance one document per act, and later effortlessly split these up into individual chapter or -scene documents. - - -.. _a_intro_features: - -Key Features -============ - -Below are some key features of novelWriter. - -**Focus on writing** - The aim of the user interface is to let you focus on writing instead of spending time formatting - text. Formatting is therefore limited to a small set of formatting tags for simple things like - text emphasis and paragraph alignment. Additional shortcodes are available for special - formatting cases when you need them. - - When you really want to focus on just writing, you can switch the editor into **Focus Mode** - where only the text editor panel itself is visible, and the project structure view is hidden - away. - -**Keep an eye on your notes** - The main window can optionally show a document viewer to the right of the editor. The viewer - is intended for displaying another scene document, your character notes, plot notes, or any - other document you may need to reference while writing. It is not intended as a preview panel - for the document you're editing, but if you wish, you can also use it for this purpose. - -**Organise your documents how you like** - You can split your novel project up into as many individual documents as you want to. When you - 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 of the project tree. You can also start out with fewer documents and then - later split them into multiple documents based on chapter and scene headings. - -**Multi-novel project support** - The main parts of your project is split up into top level special folders called "Root" folders. - Your main story text lives in the "Novel" root folder. You can have multiple such folders in a - project, and rename them to whatever you want. This allows you to keep a series of individual - novels with the same characters and world building in the same project, and create manuscripts - for them separately. - -**Keep track of your story elements** - All documents in your project can be assigned a :term:`tag` that you can then :term:`reference` - from any other document or note. In fact, you can add a new tag under each heading of a note if - you need to be able to reference specific sections of it, or you want to keep several topics or - scenes in the same document. - -**Get an overview of your story** - It is not the documents themselves that define the chapters and scenes of your story, but the - headings within them. In the **Outline View** on the main window you can see an outline of all - the chapter and scene headings of each novel root folder in your project. If they have any - references in them, like which character is in what chapter and scene, these are listed in - additional columns. - - You can also add a synopsis to each chapter or scene, which can be listed here as well. You have - the option to add or remove columns of information from this outline. A subset of the outline - information is also available in the **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 show 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 to free up - space when you don't need it. - -**Assembling 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 included, you can use the **Build Manuscript** tool to - do so. The tool lets you select what information you want to include in the generated document, - and how it is formatted. You can send the result to a printer, or generate an Open Document or - Word Document file that can be opened by most office type word processors. You can also generate - the result as HTML, or Markdown, both suitable for further conversion to other formats. - - -.. _a_intro_screenshots: - -Screenshots -=========== - -.. figure:: images/screenshot_light.png - :class: dark-light - - novelWriter with light colour theme - -.. figure:: images/screenshot_dark.png - :class: dark-light - - novelWriter with dark colour theme diff --git a/docs/source/int_overview.rst b/docs/source/int_overview.rst deleted file mode 100644 index 7539fb1f..00000000 --- a/docs/source/int_overview.rst +++ /dev/null @@ -1,100 +0,0 @@ -.. _a_reading: - -****************** -What to Read First -****************** - -The documentation of novelWriter is quite extensive. There are a lot of features to get used to, -but you don't need to know all of them to get started. - -The chapters below labelled "Essential Information" are the ones you need to know to use the -application correctly. By "correctly" it is meant: in a way so novelWriter understands the basic -structure of your text. It collects a lot of information from your text and uses it to display the -structure of it in various ways to help you get an overview of your writing. - -The chapters labelled "Recommended Reading" includes additional information on how the different -parts of the application work and what the features do. - -The "Optional" and "Lookup" chapters contain additional information or lookup tables that are not -essential for using the application. - - -Using novelWriter -================= - -In order to use novelWriter effectively, you need to know the basics of how it works. The following -chapters will explain the main principles. They start with the basics, and get more detailed as you -read on. - -:ref:`a_breakdown` -- Essential Information - 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 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 from how you - use headings. Tags and references are implemented by special keywords. - -:ref:`a_kb` -- Optional / Lookup - This chapter lists all the keyboard shortcuts in novelWriter and what they do. Most of the - shortcuts are also listed next to their menu entries inside the app, or in tool tips. This - chapter is mostly for reference. - -: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 - intended use is explained here. - - -Organising Your Projects -======================== - -In addition to managing a collection of plain text files, novelWriter can interpret and map the -structure of your novel and show you additional information about its flow and content. In order -to take advantage of these features, you must structure your text in a specific way and add some -meta data for it to extract. - -:ref:`a_proj` -- Essential Information - This chapter explains how you organise the content of your project, and how to set up automated - backups of your work. - -:ref:`a_struct` -- Essential Information - This chapter covers the way your novel's structure is encoded into the text documents. It - explains how the different levels of headings are used, and some special formatting for - different kinds of headings. - -:ref:`a_references` -- Recommended Reading - This chapter explains how you organise your notes, and how the Tags and References system works. - This system lets you cross-link your documents in your project, and display these references in - the application interface. - -:ref:`a_manuscript` -- Recommended Reading - This chapter explains how the **Manuscript Build** tool works, how you can control the way - chapter titles are formatted, and how scene and section breaks are handled. - - -Writing Aids -============ - -We are in the process of adding tools to novelWriter that can be used to track more information -about your project to assist in your writing. These tools are entirely optional and will not be in -your way if you choose to not use them. - -:ref:`a_story_structure` -- Writing Tools - Story structure comments are a way to add meta data that can be used to analyse the structure of - your writing. These comments can be exported to spreadsheets for analysis. - - -Additional Details & Technical Topics -===================================== - -The Additional Details and the Technical Topics sections contain more in-depth information about -how various bits of novelWriter works. This information is not essential to getting started using -novelWriter. diff --git a/docs/source/int_started.rst b/docs/source/int_started.rst deleted file mode 100644 index 88c1aba3..00000000 --- a/docs/source/int_started.rst +++ /dev/null @@ -1,245 +0,0 @@ -.. _a_started: - -********************** -Setup and Installation -********************** - -.. _Enchant: http://rrthomas.github.io/enchant/ -.. _GitHub: https://github.com/vkbo/novelWriter -.. _Downloads page: https://download.novelwriter.io -.. _PPA: https://launchpad.net/~vkbo/+archive/ubuntu/novelwriter -.. _Pre-Release PPA: https://launchpad.net/~vkbo/+archive/ubuntu/novelwriter-pre -.. _PyPi: https://pypi.org/project/novelWriter/ -.. _python.org: https://www.python.org/downloads/ -.. _Releases: https://github.com/vkbo/novelWriter/releases -.. _AppImage: https://appimage.org/ - -Ready-made packages and installers for novelWriter are available for all major platforms, including -Linux, Windows and MacOS, from the `Downloads page`_. See below for additional 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, -or start novelWriter from the command line. - -Spell checking in novelWriter is provided by a third party library called Enchant_. Generally, it -should pull dictionaries from your operating system automatically. However, on Windows they must be -installed manually. See :ref:`a_custom_dict` for more details. - - -.. _a_started_windows: - -Installing on Windows -===================== - -You can install novelWriter with both Python and library dependencies embedded using the Windows -Installer (setup.exe) file from the `Downloads page`_, or from the Releases_ page on GitHub_. -Installing it should be straightforward. - -If you have any issues, try uninstalling the previous version and making a fresh install. If you -already had a version installed via a different method, you should uninstall that first as having -multiple installations has been known to cause problems. - - -.. _a_started_linux: - -Installing on Linux -=================== - -A Debian package can be downloaded from the `Downloads page`_, or from the Releases_ page on -GitHub_. This package should work on both Debian, Ubuntu and Linux Mint, at least. - -If you prefer, you can also add the novelWriter repository on Launchpad to your package manager. -The Launchpad packages `are signed by the author `__. - - -Ubuntu ------- - -You can add the Ubuntu PPA_ and install novelWriter with the following commands. - -.. code-block:: bash - - sudo add-apt-repository ppa:vkbo/novelwriter - sudo apt update - sudo apt install novelwriter - -If you want the `Pre-Release PPA`_ instead, add the ``ppa:vkbo/novelwriter-pre`` repository. - - -Debian and Mint ---------------- - -Since this is a pure Python package, the Launchpad PPA can in principle also be used on Debian or -Mint. However, the above command will fail to add the signing key, as it is Ubuntu-specific. -Instead, do one of the following: - -.. tab-set:: - - .. tab-item:: Debian 13 (Trixie) and Later - :selected: - - As of Debian 13 (Trixie) and other Debian derivatives, the keyring format has changed. - The following instructions use Sequoia to install the key in the correct format, and sets up - the source file in the new format. - - If you don't have Sequoia installed, first run: - - .. code-block:: bash - - sudo apt install sq - - Import the keyring: - - .. code-block:: bash - - sudo sq network keyserver --server hkps://keyserver.ubuntu.com search "F19F1FCE50043114" \ - --output /usr/share/keyrings/novelwriter-ppa-keyring.gpg --overwrite - - Add the source file: - - .. tab-set:: - - .. tab-item:: Releases - :selected: - - .. code-block:: bash - - sudo sh -c "cat > /etc/apt/sources.list.d/novelwriter.sources" << EOF - Types: deb - URIs: http://ppa.launchpad.net/vkbo/novelwriter/ubuntu/ - Suites: noble - Components: main - Signed-By: /usr/share/keyrings/novelwriter-ppa-keyring.gpg - EOF - - .. tab-item:: Pre-Releases - - .. code-block:: bash - - sudo sh -c "cat > /etc/apt/sources.list.d/novelwriter-pre.sources" << EOF - Types: deb - URIs: http://ppa.launchpad.net/vkbo/novelwriter-pre/ubuntu/ - Suites: noble - Components: main - Signed-By: /usr/share/keyrings/novelwriter-ppa-keyring.gpg - EOF - - .. tab-item:: Debian 12 (Bookworm) and Earlier - - For Debian 12 (Bookworm) and older, and equivalent derivatives, use the old keyring format - and apt sources list file format. - - Import the keyring: - - .. code-block:: bash - - sudo gpg --no-default-keyring --keyring /usr/share/keyrings/novelwriter-ppa-keyring.gpg \ - --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys F19F1FCE50043114 - - Add the source list: - - .. tab-set:: - - .. tab-item:: Releases - :selected: - - .. code-block:: bash - - echo "deb [signed-by=/usr/share/keyrings/novelwriter-ppa-keyring.gpg] http://ppa.launchpad.net/vkbo/novelwriter/ubuntu noble main" | sudo tee /etc/apt/sources.list.d/novelwriter.list - - .. tab-item:: Pre-Releases - - .. code-block:: bash - - echo "deb [signed-by=/usr/share/keyrings/novelwriter-ppa-keyring.gpg] http://ppa.launchpad.net/vkbo/novelwriter-pre/ubuntu noble main" | sudo tee /etc/apt/sources.list.d/novelwriter-pre.list - - .. tip:: - If you get an error message like ``gpg: failed to create temporary file`` when importing the key - from the Ubuntu keyserver, try creating the folder it fails on, and import the key again: - - .. code-block:: bash - - sudo mkdir -m 700 /root/.gnupg/ - -**Install novelWriter** - -Then run the update and install commands as for Ubuntu: - -.. code-block:: bash - - sudo apt update && sudo apt install novelwriter - - -AppImage Releases ------------------ - -For other Linux distros than the ones mentioned above, the primary option is AppImage_. These are -completely standalone images for the app that include the necessary environment to run novelWriter. -They can of course be run on any Linux distro, if you prefer this to native packages. - -.. note:: - novelWriter generally doesn't support Python versions that have reached end of life. If your - Linux distro still uses older Python versions and novelWriter won't run, you may want to try the - AppImage instead. - - -.. _a_started_macos: - -Installing on MacOS -=================== - -You can install novelWriter with both its Python and library dependencies embedded using the DMG -application image file from the `Downloads page`_, or from the Releases_ page on GitHub_. -Installing it should be straightforward. - -* Download the DMG file and open it. Then drag the novelWriter icon to the :guilabel:`Applications` - folder on the right. This will install it into your :guilabel:`Applications`. -* The first time you try to launch it, it will say that the bundle cannot be verified, simply press - the :guilabel:`Open` button to add an exception. -* If you are not presented with an :guilabel:`Open` button in the dialog, launch the application - again by right clicking on the application in Finder and selecting :guilabel:`Open` from the - context menu. - -The context menu can also be accessed by option-clicking if you have a one button mouse. This is -done by holding down the option key on your keyboard and clicking on the application in Finder. - -.. note:: - The novelWriter DMG is not signed because Apple doesn't currently provide a way for non-profit - open source projects to properly sign their installers. The novelWriter project doesn't have the - funding to pay for a commercial software signing certificate. - - -.. _a_started_pip: - -Installing from PyPi -==================== - -novelWriter is also available on the Python Package Index, or PyPi_. This install method works on -all supported operating systems with a suitable Python environment. - -To install from PyPi you must first have the ``python`` and ``pip`` commands available on your -system. You can download Python from `python.org`_. It is recommended that you install the latest -version. If you are on Windows, also make sure to select the "Add Python to PATH" option during -installation. - -To install novelWriter from PyPi, use the following command: - -.. code-block:: bash - - pip install novelwriter - -To upgrade an existing installation, use: - -.. code-block:: bash - - pip install --upgrade novelwriter - -When installing via pip, novelWriter can be launched from command line with: - -.. code-block:: bash - - novelwriter - -Make sure the install location for pip is in your PATH variable. This is not always the case by -default, and then you may get a "Not Found" error when running the ``novelwriter`` command. diff --git a/docs/source/more_counting.rst b/docs/source/more/counting.rst similarity index 99% rename from docs/source/more_counting.rst rename to docs/source/more/counting.rst index 7272c9fc..90931764 100644 --- a/docs/source/more_counting.rst +++ b/docs/source/more/counting.rst @@ -1,4 +1,4 @@ -.. _a_counting: +.. _docs_more_counting: ******************** Word and Text Counts diff --git a/docs/source/more_customise.rst b/docs/source/more/customise.rst similarity index 97% rename from docs/source/more_customise.rst rename to docs/source/more/customise.rst index 924a0ef7..2b005d56 100644 --- a/docs/source/more_customise.rst +++ b/docs/source/more/customise.rst @@ -1,4 +1,4 @@ -.. _a_custom: +.. _docs_more_custom: ************** Customisations @@ -11,7 +11,7 @@ There are a few ways you can customise novelWriter yourself. Currently, you can your own syntax themes, and install additional dictionaries. -.. _a_custom_dict: +.. _docs_more_custom_dict: Spell Check Dictionaries ======================== @@ -61,7 +61,7 @@ You can find the various dictionaries on the `Free Desktop`_ website. each line and download that. -.. _a_custom_theme: +.. _docs_more_custom_theme: Syntax and GUI Themes ===================== @@ -84,7 +84,7 @@ Remember to also change the name of your theme by modifying the ``name`` setting file, otherwise you may not be able to distinguish them in **Preferences**. For novelWriter to be able to locate the custom theme files, you must copy them to the -:ref:`a_locations_data` location in your home or user area. There should be a folder there named +:ref:`docs_technical_locations_data` location in your home or user area. There should be a folder there named ``syntax`` for syntax themes, just ``themes`` for GUI themes, and ``icons`` for icon themes. These folders are created the first time you start novelWriter. diff --git a/docs/source/int_howto.rst b/docs/source/more/howto.rst similarity index 98% rename from docs/source/int_howto.rst rename to docs/source/more/howto.rst index 0a393f40..57624063 100644 --- a/docs/source/int_howto.rst +++ b/docs/source/more/howto.rst @@ -1,4 +1,4 @@ -.. _a_howto: +.. _docs_more_howto: ************* Tips & Tricks @@ -76,7 +76,7 @@ Layout Tricks indented, you can disable the indentation by explicitly adding text alignment. For instance by adding ``<<`` to the end to left-align it. Aligned paragraphs are not indented. - See :ref:`a_fmt_align` for more details. + See :ref:`docs_usage_align_indent` for more details. Organising Your Text diff --git a/docs/source/more_projectformat.rst b/docs/source/more/project_format.rst similarity index 91% rename from docs/source/more_projectformat.rst rename to docs/source/more/project_format.rst index 0648a453..b002eba9 100644 --- a/docs/source/more_projectformat.rst +++ b/docs/source/more/project_format.rst @@ -1,4 +1,4 @@ -.. _a_prjfmt: +.. _docs_more_project_formats: ********************** Project Format Changes @@ -23,7 +23,7 @@ A full project file format specification is available under "More Documents". have the option to decline the upgrade. -.. _a_prjfmt_1_5: +.. _docs_more_project_formats_1_5: Format 1.5 Changes ================== @@ -37,7 +37,7 @@ heading of the document is now saved to the item rather than in the index. The c automatically the first time a project is loaded. No user action is required. -.. _a_prjfmt_1_4: +.. _docs_more_project_formats_1_4: Format 1.4 Changes ================== @@ -51,7 +51,7 @@ compact format that is simpler and faster to parse, and easier to extend. The co automatically the first time a project is loaded. No user action is required. -.. _a_prjfmt_1_3: +.. _docs_more_project_formats_1_3: Format 1.3 Changes ================== @@ -71,25 +71,26 @@ should be used only a few places in any given project. These are as follows: **Title Pages** * The formatting of the level one title on the title page must be changed from ``# Title Text`` to - ``#! Title Text`` in order to retain the previous functionality. See :ref:`a_fmt_head`. + ``#! Title Text`` in order to retain the previous functionality. + See :ref:`docs_usage_headers_levels`. * Any text that was previously centred on the page must be manually centred using the text - alignment feature. See :ref:`a_fmt_align`. + alignment feature. See :ref:`docs_usage_align_indent`. **Unnumbered Chapters** * Since the specific layout for unnumbered chapters has been dropped, such chapters must all use the ``##! Chapter Name`` formatting code instead of ``## Chapter Name``. This also includes chapters marked by an asterisk: ``## *Chapter Name``, as this feature has also been dropped. - See :ref:`a_fmt_head`. + See :ref:`docs_usage_headers_levels`. **Plain Pages** * The layout named "Plain Page" has also been removed. The only feature of this layout was that it ensured that the content always started on a fresh page. In the new format, fresh pages can be - set anywhere in the text with the ``[NEW PAGE]`` code. See :ref:`a_fmt_break`. + set anywhere in the text with the ``[NEW PAGE]`` code. See :ref:`docs_usage_formatting_breaks`. -.. _a_prjfmt_1_2: +.. _docs_more_project_formats_1_2: Format 1.2 Changes ================== @@ -99,7 +100,7 @@ This project format was introduced in novelWriter version 0.10. With this format, the way auto-replace entries were stored in the main project XML file changed. -.. _a_prjfmt_1_1: +.. _docs_more_project_formats_1_1: Format 1.1 Changes ================== @@ -113,7 +114,7 @@ It also reduces the number of meta data and cache files. These files are automat an old project is opened. This was also when the Table of Contents file was introduced. -.. _a_prjfmt_1_0: +.. _docs_more_project_formats_1_0: Format 1.0 Changes ================== diff --git a/docs/source/usage_typography.rst b/docs/source/more/typography.rst similarity index 99% rename from docs/source/usage_typography.rst rename to docs/source/more/typography.rst index 189e0dd1..99db637a 100644 --- a/docs/source/usage_typography.rst +++ b/docs/source/more/typography.rst @@ -1,4 +1,4 @@ -.. _a_typ: +.. _docs_more_typographical: ******************* Typographical Notes diff --git a/docs/source/project_manuscript.rst b/docs/source/project_manuscript.rst index 18e64441..963a5865 100644 --- a/docs/source/project_manuscript.rst +++ b/docs/source/project_manuscript.rst @@ -47,7 +47,7 @@ A collapsible panel of word and character counts are also available below the pr These are calculated from the text you have included in the document, and are more accurate counts than what's available in the project tree since they are counted *after formatting*. -For a detailed description on how they are counted, see :ref:`a_counting`. +For a detailed description on how they are counted, see :ref:`docs_more_counting`. .. _a_manuscript_settings: @@ -98,7 +98,7 @@ Formatting Headings The **Headings** page of the **Manuscript Build Settings** dialog. The **Headings** page of the **Manuscript Build Settings** dialog allows you to set how the -headings in your :term:`Novel Documents` are formatted. By default, the title is just copied as-is, +headings in your Novel Documents are formatted. By default, the title is just copied as-is, indicated by the ``{Title}`` format. You can change this to for instance add chapter numbers and scene numbers, or insert character names, like shown in the figure above. @@ -136,7 +136,7 @@ If you wish to distinguish between so-called soft and hard scene breaks, you can alternative scene heading format in your text. You can then give these headings a different formatting in the **Headings** settings. -See :ref:`a_fmt_head` for more info on how to format headings in your text. +See :ref:`docs_usage_headers_levels` for more info on how to format headings in your text. Output Settings diff --git a/docs/source/project_overview.rst b/docs/source/project_overview.rst index 58a327de..9cbf2c59 100644 --- a/docs/source/project_overview.rst +++ b/docs/source/project_overview.rst @@ -18,7 +18,7 @@ will open the **Welcome** dialog, where you can select the :guilabel:`New` butto you in creating a new 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 chapter :ref:`a_storage`. +If you're interested in the details, you can have a look at the chapter :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 @@ -58,7 +58,7 @@ Deleted Documents Deleted documents are moved into a special **Trash** root folder. Documents in the trash folder can then be deleted permanently, either individually, or by emptying the trash from the menu. Documents -in the trash folder are removed from the :term:`project index` and cannot be referenced. +in the trash folder are removed from the project index and cannot be referenced. A document or a folder can be moved to trash from the **Project** menu, or by pressing :kbd:`Ctrl+Shift+Del`. Root folders can only be removed when they are empty. @@ -161,7 +161,7 @@ Word Counts ----------- A character, word and paragraph count is maintained for each document, as well as for each section -of a document following a :term:`heading`. The word count and change of words in the +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. @@ -170,11 +170,11 @@ The word counts are not updated in real time, but run in the background every fe 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 :term:`project index`. If the +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:`a_counting`. +The rules for how the counts are made is covered in more detail in :ref:`docs_more_counting`. .. _a_proj_settings: @@ -280,7 +280,7 @@ 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:`a_storage`. +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. diff --git a/docs/source/project_references.rst b/docs/source/project_references.rst deleted file mode 100644 index 1bea77b2..00000000 --- a/docs/source/project_references.rst +++ /dev/null @@ -1,244 +0,0 @@ -.. _a_references: - -******************* -Tags and References -******************* - -In novelWriter there are no forms or tables to fill in to define characters, locations or other -elements of your story. Instead, you create :term:`project notes` which you can mark as -representing these story elements by creating a :term:`tag`. Whenever you want to link a piece of -your story to a note defining a story element, like a character, you create a :term:`reference` -back to that tag. You can also cross-link your project notes in the same way. - -This is perhaps one of the features that makes novelWriter different from other, similar -applications. It is therefore not always obvious to new users how this is supposed to work, so -this chapter hopes to explain in more detail how to use this tags and references system. - -.. tip:: - - If you find the Tags and Reference system difficult to follow just from reading this chapter, - you can create a new project in the **Welcome** dialog's New project form and select "Create an - example project" from the "Pre-fill project" option. The example project contains several - examples of tags and references. - - -.. _a_references_metadata: - -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 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 first -starting your project. For instance, it may make more sense to define all your scenes, and even -chapters, in a single document at first, or perhaps a document per act. You can later split these -documents up using the document split feature. See :ref:`a_ui_tree_split_merge` for more details. - -You can do the same with your notes. You can treat each heading as an independent element of your -notes that can be referenced somewhere else. That way you can collect all your minor or background -characters in a single note file, and still be able to reference them individually by separating -them with headings and assigning each a tag. Or, you can lay out your plot in a single document and -have a tag for each plot stage under separate headings. - - -.. _a_references_tags: - -How to Use Tags -=============== - -A "tag" in novelWriter is a word or phrase that you define as belonging to a heading. Tags are set -by using the ``@tag`` :term:`keyword`. - -The basic format of a tag is ``@tag: tagName``. - -An alternative format of a tag is ``@tag: tagName | displayName``. - -``tagName`` (Required) - This is a unique identifier of your choosing. It is the value you use later for making - references back to this document, or section of the document. - -``displayName`` (Optional) - This is an optional display name used for the tag. When you build your manuscript, you can for - instance insert the point of view character name directly into chapter headings. By default, the - ``tagName`` value is used in such headings, but if you use a shortened format internally in your - project, you can use this to specify a more suitable format for your manuscript headings. - -You can only set **one** tag per heading, and the tag has to be unique across **all** documents in -the project. - -After a tag has been defined, it can be referenced in novel documents, or cross-referenced in other -notes. Tags will also show up in the **Outline View** and in the references panel under the -document viewer when a document is open in the viewer. - -The syntax highlighter will indicate to you that the keyword is correctly used and that the tag is -allowed, that is, the tag is unique. Duplicate tags should be detected as long as the index is up -to date. An invalid tag should have a green wiggly line under it, and will not receive the colour -that valid tags do. - -The tag is the only part of these notes that novelWriter uses. The rest of the document content is -there for you to use in whatever way you wish. Of course, the content of the documents can be added -to the manuscript, or an outline document. If you want to compile a single document of all your -notes, you can do this from the **Manuscript Build** tool. - -.. versionadded:: 2.2 - - Tags are no longer case sensitive. The tags are by default displayed with the capitalisation you - use when defining the tag, but you don't have to use the same capitalisation when referencing - it later. - -.. versionadded:: 2.3 - - Tags can have an optional display name for manuscript builds. - -.. versionadded:: 2.6 - - You can now add tags also to Novel Documents. These can be used for cross-referencing between - chapters and scenes, and also from notes if desired. - -Example of a heading with a tag for a character of the story: - -.. code-block:: md - - # Character: Jane Doe - - @tag: Jane | Jane Doe - - Some information about the character Jane Doe. - -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 with the value "Jane", and you will -be able to reference 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 available root folder types. They are also -covered in the next section. - - -.. _a_references_references: - -How to Use References -===================== - -Each heading of any level in your project can contain references to tags set in project notes. The -references are gathered by the indexer and used to generate the **Outline View**, among other -things. - -References are set as a :term:`keyword` and a list of corresponding tags. The valid keywords are -listed below. The format of a reference line is ``@keyword: value1, [value2] ... [valueN]``. All -reference keywords allow multiple values. - -``@pov`` - The point-of-view character for the current section. The target must be a note tag in a - **Character** type root folder. - -``@focus`` - The character that has the focus for the current section. This can be used in cases where the - focus is not a point-of-view character. The target must be a note tag in a **Character** type - root folder. - -``@char`` - Other characters in the current section. The target must be a note tag in a **Character** type - root folder. This should not include the point-of-view or focus character if those references - are used. - -``@plot`` - The plot or subplot advanced in the current section. The target must be a note tag in a **Plot** - type root folder. - -``@time`` - The timelines touched by the current section. The target must be a note tag in a **Timeline** - type root folder. - -``@location`` - The location the current section takes place in. The target must be a note tag in a - **Locations** type root folder. - -``@object`` - Objects present in the current section. The target must be a note tag in a **Object** type root - folder. - -``@entity`` - Entities present in the current section. The target must be a note tag in an **Entities** type - root folder. - -``@custom`` - Custom references in the current section. The target must be a note tag in a **Custom** type - root folder. The custom folder are for any other category of notes you may want to use. - -``@mention`` - Anything mentioned, but not present in the current section. It is intended for those cases where - you reveal details about a character or place in a scene without it being otherwise a part of - it. This can be useful when checking for consistency later. Any tag in any root note folder can - be listed under mentions. - -``@story`` - This is used when referencing a Novel Document, like a scene or chapter, from somewhere else in - your project. - -The syntax highlighter will alert the user that the tags and references are used correctly, and -that the tags referenced exist. - -.. note:: - - The highlighter may be mistaken if the index of defined tags is out of date. If so, press - :kbd:`F9` to regenerate it, or select **Rebuild Index** from the **Tools** menu. 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 **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 -mouse while holding down the :kbd:`Ctrl` key. Clicked links are always opened in the view panel. - -Project notes don't show up in the **Outline View**, so referencing between notes is only -meaningful if you want to be able to click-navigate between them, or of course if you just want to -highlight that two notes are related. - -.. tip:: - - If you cross-reference between notes and export your project as an HTML document using the - **Manuscript Build** tool, the cross-references become clickable links in the exported HTML - document as well. - -Example of a novel document with references to characters and plots: - -.. code-block:: md - - ## Chapter 1 - - @pov: Jane - - ### Scene 1 - - @char: John, Sam - @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 **Create Note for -Tag** from the menu. - -.. versionadded:: 2.2 diff --git a/docs/source/project_structure.rst b/docs/source/project_structure.rst index ea78cc4a..5e3affc4 100644 --- a/docs/source/project_structure.rst +++ b/docs/source/project_structure.rst @@ -24,22 +24,22 @@ Subfolders under root folders have no impact on the structure of the novel itsel instead dictated by the heading level of the headings within the documents. Four levels of headings are supported, signified by the number of hashes (``#``) preceding the -title. See also the :ref:`a_fmt` section for more details about the markup syntax. +title. .. note:: The heading levels are not only important when generating the manuscript, they are also used by the indexer when building the outline tree in the **Outline View** as well as in the **Novel Tree**. Each heading also starts a new region where new Tags and References can be defined. See - :ref:`a_references` for more details. + a_references for more details. The syntax for the four basic heading types, and the three special types, is listed in section -:ref:`a_fmt_head`. The meaning of the four levels for the structure of your novel is as follows: +:ref:`docs_usage_headers_levels`. The meaning of the four levels for the structure of your novel is as follows: **Heading Level 1: Partition** This heading level signifies that the text refers to a top level heading. This is useful when you want to split the manuscript up into books, parts, or acts. These headings are not required. - The novel title itself should use the special heading level ``#!`` covered in :ref:`a_fmt_head`. + The novel title itself should use the special heading level ``#!`` covered in :ref:`docs_usage_headers_levels`. **Heading Level 2: Chapter** This heading level signifies a chapter. Each time you want to start a new chapter, you must add @@ -52,7 +52,7 @@ The syntax for the four basic heading types, and the three special types, is lis This heading level signifies a scene. You must provide a title text, but the title text can be replaced with a scene separator or just skipped entirely when you build your manuscript. If you need to distinguish between hard and soft scene breaks, there is an alternative format for - scenes you can use for this distinction. The formatting is covered in :ref:`a_fmt_head`. See + scenes you can use for this distinction. The formatting is covered in :ref:`docs_usage_headers_levels`. See also :ref:`a_struct_heads_scenes`. **Heading Level 4: Section** @@ -63,7 +63,7 @@ The syntax for the four basic heading types, and the three special types, is lis Page breaks can be automatically added before titles, partition, chapter and scene headings from the **Manuscript Build** tool when you build your project to a format that supports page breaks. If -you want page breaks in other places, you have to specify them manually. See :ref:`a_fmt_break`. +you want page breaks in other places, you have to specify them manually. See :ref:`docs_usage_formatting_breaks`. .. tip:: @@ -72,13 +72,6 @@ you want page breaks in other places, you have to specify them manually. See :re them in a draft manuscript. You can also insert point-of-view character names in chapter titles. See the :ref:`a_manuscript` page for more details. -.. note:: - - As of 2.6, the heading levels internally in novelWriter do not map directly to heading levels in - manuscript documents. In manuscript documents, chapters are considered the top level heading, - and partitions become plain text paragraphs with a larger font. - - .. versionadded:: 2.6 .. _a_struct_heads_title: @@ -115,7 +108,7 @@ for instance the author's name and details. If you want an additional page of text after the title page, starting on a fresh page, you can add ``[new page]`` on a line by itself, and continue the text after it. This will insert a page break -before the text. See also :ref:`a_fmt_break`. +before the text. See also :ref:`docs_usage_formatting_breaks`. .. _a_struct_heads_unnum: diff --git a/docs/source/tech_locations.rst b/docs/source/technical/locations.rst similarity index 93% rename from docs/source/tech_locations.rst rename to docs/source/technical/locations.rst index cc4b612e..cbc8a5d0 100644 --- a/docs/source/tech_locations.rst +++ b/docs/source/technical/locations.rst @@ -1,4 +1,4 @@ -.. _a_locations: +.. _docs_technical_locations: ************** File Locations @@ -10,7 +10,7 @@ novelWriter will create a few files on your system outside of the application fo file locations are described in this chapter. -.. _a_locations_conf: +.. _docs_technical_locations_conf: Configuration ============= @@ -33,7 +33,7 @@ user's username on Windows. different way, these locations may also be different. -.. _a_locations_data: +.. _docs_technical_locations_data: Application Data ================ @@ -62,4 +62,4 @@ The Application Data location also holds several folders: ``icons``, ``syntax`` and ``themes`` These folders are empty by default, but this is where the user can store custom theme files. - See :ref:`a_custom` for more details. + See :ref:`docs_more_custom` for more details. diff --git a/docs/source/tech_source.rst b/docs/source/technical/source.rst similarity index 99% rename from docs/source/tech_source.rst rename to docs/source/technical/source.rst index 6e0fc62b..2e9f0bbd 100644 --- a/docs/source/tech_source.rst +++ b/docs/source/technical/source.rst @@ -1,4 +1,4 @@ -.. _a_source: +.. _docs_technical_source: ******************* Running from Source diff --git a/docs/source/tech_storage.rst b/docs/source/technical/storage.rst similarity index 99% rename from docs/source/tech_storage.rst rename to docs/source/technical/storage.rst index fac04949..9111c7e5 100644 --- a/docs/source/tech_storage.rst +++ b/docs/source/technical/storage.rst @@ -1,4 +1,4 @@ -.. _a_storage: +.. _docs_technical_storage: ****************** How Data is Stored diff --git a/docs/source/tech_tests.rst b/docs/source/technical/tests.rst similarity index 99% rename from docs/source/tech_tests.rst rename to docs/source/technical/tests.rst index f4502594..56623ff4 100644 --- a/docs/source/tech_tests.rst +++ b/docs/source/technical/tests.rst @@ -1,4 +1,4 @@ -.. _a_pytest: +.. _docs_technical_pytest: ************* Running Tests diff --git a/docs/source/usage/tags_and_references.rst b/docs/source/usage/tags_and_references.rst index 9a88b46b..1ee1ee4f 100644 --- a/docs/source/usage/tags_and_references.rst +++ b/docs/source/usage/tags_and_references.rst @@ -32,7 +32,7 @@ the documents themselves. See :ref:`docs_usage_headers` for more details. Theref also associated with headings, and not the documents directly. A "tag" in novelWriter is a word or phrase that you define as belonging to a heading. Tags are set -by using the ``@tag`` :term:`keyword`. +by using the ``@tag`` keyword. The basic format of a tag is ``@tag: TagName``. diff --git a/docs/source/usage_breakdown.rst b/docs/source/usage_breakdown.rst index b4f0e4ff..3371cc3e 100644 --- a/docs/source/usage_breakdown.rst +++ b/docs/source/usage_breakdown.rst @@ -10,7 +10,7 @@ How it Works .. _Office Open XML: https://en.wikipedia.org/wiki/Office_Open_XML .. _version control: https://en.wikipedia.org/wiki/Version_control -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 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 this documentation these features will be covered in more detail. @@ -88,7 +88,7 @@ Novel View and Editor View A screenshot of the Novel Tree and Editor View. When the application is in **Novel Tree View** mode, the project tree is replaced by an overview of -your novel structure for a specific Novel :term:`root folder`. Instead of showing individual +your novel structure for a specific Novel root folder. Instead of showing individual documents, the tree now shows all headings of your novel text. This includes multiple headings within the same document. @@ -137,7 +137,7 @@ By default, novelWriter uses a light colour theme. You can also choose between a theme that have neutral colours, or a series of other included themes, from **Preferences**. If you wish, you *can* create your own colour themes, and even have them added to the application. -See :ref:`a_custom_theme` for more details. +See :ref:`docs_more_custom_theme` for more details. Switching the GUI colour theme does not affect the colours of the editor and viewer. They have separate colour selectable from the "Document colour theme" setting in **Preferences**. They are @@ -173,12 +173,6 @@ These two shortcuts make it possible to jump between all these GUI elements with for the mouse or touchpad. -.. _a_breakdown_project: - -Project Layout -============== - - .. _a_breakdown_export: Building a Manuscript @@ -216,7 +210,7 @@ Project Storage The files of a novelWriter project are stored in a dedicated project folder. The project structure is kept in a file at the root of this folder called ``nwProject.nwx``. All the document files and associated meta data are stored in other folders below the project folder. For a more technical -description of what all the files mean and how they're organised, see the :ref:`a_storage` section. +description of what all the files mean and how they're organised, see the :ref:`docs_technical_storage` section. This way of storing data was chosen for several reasons. @@ -243,7 +237,7 @@ well, which makes it easier to track them with version control software. You should not add additional files to the project folder yourself. Nor should you, as a rule, manually edit files within it. If you really must manually edit the text files, e.g. with some - automated task you want to perform, you need to rebuild the :term:`Project Index` when you open + automated task you want to perform, you need to rebuild the Project Index when you open the project again. Editing text files in the ``content`` folder is less risky as these are just plain text. Editing diff --git a/docs/source/usage_format.rst b/docs/source/usage_format.rst deleted file mode 100644 index 76f32cf2..00000000 --- a/docs/source/usage_format.rst +++ /dev/null @@ -1,71 +0,0 @@ -.. _a_fmt: - -******************** -Formatting Your Text -******************** - -.. _a_fmt_hlight: - -Syntax Highlighting -=================== - -.. _a_fmt_head: - -Headings -======== - -.. _a_fmt_text: - -Text Paragraphs -=============== - -.. _a_fmt_emph: - -Text Emphasis with Markdown -=========================== - - -.. _a_fmt_shortcodes: - -Formatting with Shortcodes -========================== - - -.. _a_fmt_comm: - -Comments and Synopsis -===================== - -.. _a_fmt_footnote: - -Footnotes -========= - - -.. _a_fmt_ignore: - -Ignored Text -============ - - -.. _a_fmt_tags: - -Tags and References -=================== - - -.. _a_fmt_align: - -Paragraph Alignment and Indentation -=================================== - -.. _a_fmt_break: - -Vertical Space and Page Breaks -============================== - - -.. _a_fmt_stats: - -Inserting Word Counts in the Text -================================= diff --git a/docs/source/usage_project.rst b/docs/source/usage_project.rst index 0a19c7bd..db916520 100644 --- a/docs/source/usage_project.rst +++ b/docs/source/usage_project.rst @@ -29,19 +29,19 @@ 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 sub-documents. If the counts seem incorrect, they can be updated - by rebuilding the :term:`project index` from the **Tools** menu, or by pressing :kbd:`F9`. + by rebuilding the `project index` from the **Tools** menu, or by pressing :kbd:`F9`. **Column 3** The third column indicates whether the document is considered active or inactive in the project. You can use this flag to indicate that a document is still in the project, but should not be considered an active part of it. When you run the **Build Manuscript** tool, you can include or exclude documents based on this flag. You can change this value from the right-click - :term:`context menu`. + `context menu`. **Column 4** The fourth column shows the user-defined status or importance labels you've assigned to each project item. See :ref:`a_ui_tree_status` for more details on how to uses these labels. You can - select these labels from the :term:`context menu`, and define them in **Project Settings**. + select these labels from the `context menu`, and define them in **Project Settings**. Right-clicking an item in the project tree will open a context menu under the cursor, displaying a selection of actions that can be performed on the selected item. @@ -49,7 +49,7 @@ a selection of actions that can be performed on the selected item. At the top of the project tree, you will find a set of buttons. * The first button is a quick links button that will show you a dropdown menu of all the - :term:`root folders` in your project. Selecting one will move to that position in + `root folders` in your project. Selecting one will move to that position in the tree. You can also activate this menu by pressing :kbd:`Ctrl+L`. * The next two buttons can be used to move items up and down in the project tree. This is the only way to move root folders. @@ -127,11 +127,11 @@ Each document or folder in your project can have either a "Status" or "Importanc are flags that you control and define yourself, and novelWriter doesn't use them for anything. To modify the labels, go to their respective tabs in **Project Settings**. -The "Status" flag is intended to tag a :term:`novel document` as for instance a +The "Status" flag is intended to tag a `novel document` as for instance a 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. +`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 `root folder` it lives in. If it's in a **Novel** type folder, it uses the "Status" flag, otherwise it uses an "Importance" flag. @@ -215,7 +215,7 @@ to show a combination of all novel folders. structure of the project tree, this view will not necessarily look the same, depending on how you choose to organise your documents. See the :ref:`a_struct` page for more details. -Various meta data and information extracted from :term:`tags` can be displayed in columns in +Various meta data and information extracted from `tags` can be displayed in columns in the outline. A default set of such columns is visible, but you can turn on or off more columns from the menu button in the toolbar. The order of the columns can also be rearranged by dragging them to a different position. You column settings are saved between sessions on a per-project basis. @@ -224,7 +224,7 @@ a different position. You column settings are saved between sessions on a per-pr The **Title** column cannot be disabled or moved. -The information viewed in the outline is based on the :term:`project index`. While novelWriter does +The information viewed in the outline is based on the `project index`. While novelWriter does its best to keep the index up to date when contents change, you can always rebuild it manually by pressing :kbd:`F9` if something isn't right. @@ -232,4 +232,4 @@ The outline view itself can be regenerated by pressing the refresh button. By de is refreshed each time you switch to this view. The **Synopsis** column of the outline view takes its information from a specially formatted -comment. See :ref:`a_fmt_comm`. +comment. See :ref:`docs_usage_comments_synopsis`. diff --git a/docs/source/usage_writing.rst b/docs/source/usage_writing.rst index 245cd631..710a8bc9 100644 --- a/docs/source/usage_writing.rst +++ b/docs/source/usage_writing.rst @@ -21,7 +21,7 @@ Editing a Document 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 syntax format is described in the :ref:`a_fmt` chapter. +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 @@ -37,7 +37,7 @@ be shown. This can be set in **Preferences**. 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 :term:`references` in the editor can be opened in the viewer by moving the cursor to +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. @@ -56,17 +56,9 @@ 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:`a_custom_dict` for how to add spell checking dictionaries on Windows. + they are not. See :ref:`docs_more_custom_dict` for how to add spell checking dictionaries on Windows. -Editor Auto-Completer ---------------------- - -If you type the character ``@`` on a new line, a pop-up 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 options based on your project content. See -:ref:`a_references_completer` for more details. - .. versionadded:: 2.2 @@ -89,7 +81,7 @@ However, If you *are* viewing the same document, pressing :kbd:`Ctrl+R` from the 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 :term:`references` become clickable links. Clicking them will replace the +In the viewer `references` 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 @@ -106,7 +98,7 @@ these will appear as additional tabs in this panel. .. note:: - The **References** panel relies on an up-to-date :term:`index` of the project. + The **References** panel relies on an up-to-date `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`.