diff --git a/docs/source/images/screenshot_dark.png b/docs/source/images/screenshot_dark.png index 8fb3d728..7f581b72 100644 Binary files a/docs/source/images/screenshot_dark.png and b/docs/source/images/screenshot_dark.png differ diff --git a/docs/source/images/screenshot_default.png b/docs/source/images/screenshot_default.png index f3ce1e59..93ba2ac8 100644 Binary files a/docs/source/images/screenshot_default.png and b/docs/source/images/screenshot_default.png differ diff --git a/docs/source/images/screenshot_multi.png b/docs/source/images/screenshot_multi.png index cbbcae21..2ee5a4e1 100644 Binary files a/docs/source/images/screenshot_multi.png and b/docs/source/images/screenshot_multi.png differ diff --git a/docs/source/int_customise.rst b/docs/source/int_customise.rst index 15a7a348..1825d82d 100644 --- a/docs/source/int_customise.rst +++ b/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 -system like you do for other applications. See your distro or OS documentation for how to do this. -These dictionaries should show up as available spell check languages in novelWriter. +On Linux and MacOS, you generally only have to install hunspell, aspell or myspell dictionaries on +your system like you do for other applications. See your distro or OS documentation for how to do +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`_ -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: +and add dictionaries yourself. + +**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\\AppData\Local\enchant\hunspell`` This assumes your user profile is stored at ``C:\Users\``. 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 diff --git a/docs/source/int_howto.rst b/docs/source/int_howto.rst index 95a83876..a27df2fc 100644 --- a/docs/source/int_howto.rst +++ b/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 - free to contribute, or start a discussion on the project's `Discussions Page`_. + This section will be expanded over time. If you would like to have something added, feel free to + contribute, or start a discussion on the project's `Discussions Page`_. Managing the Project diff --git a/docs/source/int_introduction.rst b/docs/source/int_introduction.rst index ca344eb8..9bc89145 100644 --- a/docs/source/int_introduction.rst +++ b/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 -without having to cut and paste text between chapters. +single, large document. The idea is to make it easier to reorganise your project structure without +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 - formatting text. Formatting is therefore limited to a small set of formatting tags for simple - things like text emphasis and paragraph alignment. When you really want to focus on just - writing, you can switch the editor into :guilabel:`Focus Mode` where only the text editor panel - itself is visible, and the project structure view is hidden away. + 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. When you really want to focus on just writing, you can + switch the editor into :guilabel:`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. 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 - into multiple documents based on their headers. + drag-and-drop feature of the project tree. You can also start out with a few documents and then + 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 diff --git a/docs/source/int_overview.rst b/docs/source/int_overview.rst index 6cba93ff..69202c22 100644 --- a/docs/source/int_overview.rst +++ b/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 - to organise and view your project work. + 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 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 diff --git a/docs/source/int_started.rst b/docs/source/int_started.rst index 402ec687..eec91d14 100644 --- a/docs/source/int_started.rst +++ b/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 -and MacOS. See below for install instructions for each platform. +Ready-made packages and installers for novelWriter are available for all major platforms, including +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,