From d934f2bb6b4cefca8baaf3669ffdb237e85dcd8b Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Wed, 22 Feb 2023 21:24:11 +0100 Subject: [PATCH 1/6] Fix download link in docs --- docs/source/{_static => }/fileformatspec15.pdf | Bin docs/source/index.rst | 5 ----- docs/source/usage_projectformat.rst | 3 ++- 3 files changed, 2 insertions(+), 6 deletions(-) rename docs/source/{_static => }/fileformatspec15.pdf (100%) diff --git a/docs/source/_static/fileformatspec15.pdf b/docs/source/fileformatspec15.pdf similarity index 100% rename from docs/source/_static/fileformatspec15.pdf rename to docs/source/fileformatspec15.pdf diff --git a/docs/source/index.rst b/docs/source/index.rst index 4bf31fd5..ca96bf2f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -47,11 +47,6 @@ 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 - .. toctree:: :maxdepth: 1 :caption: Introduction diff --git a/docs/source/usage_projectformat.rst b/docs/source/usage_projectformat.rst index 68342eff..22e43b69 100644 --- a/docs/source/usage_projectformat.rst +++ b/docs/source/usage_projectformat.rst @@ -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 ` 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. From 2365bcbcaf668385b8a1bbf537dd3dabea5e52d6 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Wed, 22 Feb 2023 22:11:51 +0100 Subject: [PATCH 2/6] Restore main page link in docs --- docs/source/index.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index ca96bf2f..4bf31fd5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 + .. toctree:: :maxdepth: 1 :caption: Introduction From fd390c2cbadee9e706ba09503f1ddfdb0e273144 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Thu, 23 Feb 2023 08:19:05 +0100 Subject: [PATCH 3/6] Increase font size for admonitions in docs --- docs/source/conf.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 31494e79..00343e73 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -51,6 +51,12 @@ 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"
Documentation Version {release}
" pygments_style = "tango" From e50bb72dc70e528ed18543a7912586ad6ea00d31 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sat, 25 Feb 2023 18:35:39 +0100 Subject: [PATCH 4/6] Add some more space above sections --- docs/source/_static/custom.css | 3 +++ docs/source/conf.py | 1 + 2 files changed, 4 insertions(+) create mode 100644 docs/source/_static/custom.css diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css new file mode 100644 index 00000000..4afdc4fc --- /dev/null +++ b/docs/source/_static/custom.css @@ -0,0 +1,3 @@ +body article section { + margin-top: 1.8em; +} diff --git a/docs/source/conf.py b/docs/source/conf.py index 00343e73..c2851227 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -47,6 +47,7 @@ exclude_patterns = [] 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", From cc6636fe3c33411088fa31f3a597d6f54207cea8 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sat, 25 Feb 2023 18:41:40 +0100 Subject: [PATCH 5/6] Add a HowTo section --- docs/source/index.rst | 1 + docs/source/int_howto.rst | 118 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 119 insertions(+) create mode 100644 docs/source/int_howto.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 4bf31fd5..dfc2877c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -61,6 +61,7 @@ the pip tool. See :ref:`a_started` for more details. int_overview int_started int_source + int_howto int_customise .. toctree:: diff --git a/docs/source/int_howto.rst b/docs/source/int_howto.rst new file mode 100644 index 00000000..ce13261d --- /dev/null +++ b/docs/source/int_howto.rst @@ -0,0 +1,118 @@ +.. _a_howto: + +************* +Tips & Tricks +************* + +This is a list of hopefully helpful little tips on how to get the most out of novelWriter. + + +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 `__ From 1648ad2d0268c5a375db0f2a727e47ea8733b257 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sat, 25 Feb 2023 18:48:04 +0100 Subject: [PATCH 6/6] Add a contributing note to the howto docs --- docs/source/int_howto.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/int_howto.rst b/docs/source/int_howto.rst index ce13261d..09f079fd 100644 --- a/docs/source/int_howto.rst +++ b/docs/source/int_howto.rst @@ -4,8 +4,15 @@ 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 ========