Backport document changes from main

2023-02-26 11:37:28 +01:00
parent 2f3a8f505f
commit 09083ac4f5
9 changed files with 319 additions and 147 deletions
@@ -0,0 +1,3 @@
+body article section {
+    margin-top: 1.8em;
+}
@@ -1,9 +1,6 @@
 #
 # Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
+# Documentation: http://www.sphinx-doc.org/en/master/config
 #

 # -- Imports -----------------------------------------------------------------
@@ -38,24 +35,33 @@ os.environ["TZ"] = "Europe/Oslo"
 time.tzset()

 needs_sphinx = "4.0"
+extensions = []
 templates_path = ["_templates"]
 source_suffix = ".rst"
 master_doc = "index"
 today_fmt = "%A, %d %B %Y at %H:%M"
 language = "en"
 exclude_patterns = []
-pygments_style = "sphinx"
-pygments_dark_style = "monokai"

 # -- Options for HTML Output -------------------------------------------------

 html_theme = "furo"
 html_static_path = ["_static"]
+html_css_files = ["custom.css"]
 html_theme_options = {
    "light_logo": "novelwriter-light.png",
    "dark_logo": "novelwriter-dark.png",
+    "navigation_with_keys": True,
+    "dark_css_variables": {
+        "admonition-font-size": "92%",
+    },
+    "light_css_variables": {
+        "admonition-font-size": "92%",
+    },
 }
 html_title = f"<div style='text-align: center'>Documentation Version {release}</div>"
+pygments_style = "tango"
+pygments_dark_style = "native"

 # -- Options for HTMLHelp Output ---------------------------------------------

@@ -31,7 +31,7 @@ as well. novelWriter can also be run directly from the Python source, or install
 the pip tool. See :ref:`a_started` for more details.

 .. note::
-   Version 1.5 introduced a few changes that will require you to make some minor modifications to
+   Version 1.3 introduced a few changes that will require you to make some minor modifications to
   some of the headings in your project. It should be fairly quick and straightforward. Please see
   the :ref:`a_prjfmt_1_3` section for more details.

@@ -47,6 +47,11 @@ the pip tool. See :ref:`a_started` for more details.
 * PyPi Project: https://pypi.org/project/novelWriter
 * Social Media: https://fosstodon.org/@novelwriter

+.. toctree::
+   :hidden:
+
+   Main Page <self>
+
 .. toctree::
   :maxdepth: 1
   :caption: Introduction
@@ -56,6 +61,7 @@ the pip tool. See :ref:`a_started` for more details.
   int_overview
   int_started
   int_source
+   int_howto
   int_customise

 .. toctree::
@@ -0,0 +1,125 @@
+.. _a_howto:
+
+*************
+Tips & Tricks
+*************
+
+.. _Discussions Page: https://github.com/vkbo/novelWriter/discussions
+
+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`_
+
+
+Overview
+========
+
+**Managing the Project**
+
+* :ref:`a_howto_merge_documents`
+
+**Layout Tricks**
+
+* :ref:`a_howto_simple_table`
+
+**Organising Your Text**
+
+* :ref:`a_howto_chapter_intro`
+* :ref:`a_howto_soft_hard_breaks`
+
+**Other Tools**
+
+* :ref:`a_howto_convert_ywriter`
+
+
+How-Tos
+=======
+
+
+Managing the Project
+--------------------
+
+
+.. _a_howto_merge_documents:
+
+Merge Multiple Documents Into One
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you need to merge a set of documents in your project into a single document, you can achieve
+this by first making a new folder for just that purpose, and drag all the files you want merged
+into this folder. Then you can right click the folder, select :guilabel:`Transform` and
+:guilabel:`Merge Documents in FOlder`.
+
+In the dialog that pops up, the documents will be in the same order as in the folder, but you can
+also rearrange them here of you wish.
+
+
+Layout Tricks
+-------------
+
+
+.. _a_howto_simple_table:
+
+Create a Simple Table
+^^^^^^^^^^^^^^^^^^^^^
+
+The formatting tools available in novelWriter don't allow for complex structures like tables.
+However, the editor does render tabs in a similar way to regular word processors. You can set the
+width of a tab in :guilabel:`Preferences`.
+
+The tab key should have the same distance in the editor as in the viewer, so you can align text in
+columns using the tab key, and it should look the same when viewed next to the editor.
+
+This is most suitable for your notes, as the result in exported documents cannot be guaranteed to
+match.
+
+
+Organising Your Text
+--------------------
+
+
+.. _a_howto_chapter_intro:
+
+Add Introductory Text to Chapters
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sometimes chapters have a short preface, like a brief piece of text or a quote to set the stage
+before the first scene -- Some text that may not be a part of the actual following scene.
+
+If you add separate files for chapters and scenes, this is the perfect place to add such text.
+Separating chapter and scene files also allows you to set meta data for the whole chapter. Like
+list all characters present in the chapter, etc.
+
+
+.. _a_howto_soft_hard_breaks:
+
+Distinguishing Soft and Hard Scene Breaks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Depending on your writing style, you may need to separate between soft and hard scene breaks within
+chapters. Like for instance if you switch point-of-view character often.
+
+In such cases you may want to use the scene heading for hard scene breaks and section headings for
+soft scene breaks. the :guilabel:`Project Build Tool` will let you add separate formatting for the
+two when you generate your manuscript. You can for instance add the common "``* * *``" for hard
+breaks and select to hide section breaks, which will just insert an empty paragraph in their place.
+
+
+Other Tools
+-----------
+
+
+.. _a_howto_convert_ywriter:
+
+Convert Project to/from yWriter Format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. _yWriter: http://spacejock.com/yWriter7.html
+
+There is a tool available that lets you convert a yWriter_ project to a novelWriter project, and
+vice versa.
+
+The tool is available at `peter88213.github.io/yw2nw <https://peter88213.github.io/yw2nw/>`__
@@ -1,4 +1,4 @@
 furo
 sphinx>=4.0
 pygments>=2.7
-docutils==0.17.1
+docutils>=0.17.1
@@ -4,6 +4,9 @@
 How Data is Stored
 ******************

+.. _File Format Spec 1.5: _static/fileformatspec15.pdf
+.. _documentation: https://novelwriter.readthedocs.io
+
 This section contains details of how novelWriter stores and handles the project data.


@@ -39,6 +42,15 @@ The project XML file is indent-formatted, and is suitable for diff tools and ver
 most of the file will stay static, although a timesetamp is set in the meta section on line 2, and
 various meta data entries incremented, on each save.

+.. only:: not html
+
+   A full project file format specification is available in the online documentation_.
+
+.. only:: html
+
+   A full description of the current file format is available in the `File Format Spec 1.5`_
+   document, available as a PDF.
+

 Project Documents
 =================
@@ -29,7 +29,8 @@ applicable.

   **For Developers**

-   A full description of the current file format is available in the `File Format Spec 1.5`_
+   A full description of the current file format is available in the
+   :download:`File Format Spec 1.5 <fileformatspec15.pdf>`
   document, available as a PDF. This document is intended for contributors to novelWriter, those
   building project conversion tools, either to or from tne novelWriter format, and for those who
   wish to make their own templating system.