Update documentation

This commit is contained in:
Veronica Berglyd Olsen
2024-03-12 17:55:13 +01:00
parent 66cf7cce78
commit 44721fc797
4 changed files with 26 additions and 1 deletions
Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 70 KiB

+4
View File
@@ -75,6 +75,10 @@ Organising Your Text
Keep in mind that this is not what the section heading is intended for, so the app will not Keep in mind that this is not what the section heading is intended for, so the app will not
understand the section heading as a scene, but it will be formatted correctly in the manuscript. understand the section heading as a scene, but it will be formatted correctly in the manuscript.
.. versionadded:: 2.4
You can now distinguish between soft and hard scene breaks with a modified scene header. See
:ref:`a_manuscript_settings_head_hard` for more details.
Other Tools Other Tools
=========== ===========
+16
View File
@@ -63,6 +63,8 @@ In the figure, the green arrow icon and the blue pin icon indicates which docume
and the red forbidden icon indicates that a document is explicitly excluded. and the red forbidden icon indicates that a document is explicitly excluded.
.. _a_manuscript_settings_head:
Formatting Headings Formatting Headings
------------------- -------------------
@@ -86,6 +88,7 @@ Any text you add that isn't highlighted in colours will remain in your formatted
You can preview the result of these format strings by clicking :guilabel:`Apply`, and then clicking You can preview the result of these format strings by clicking :guilabel:`Apply`, and then clicking
:guilabel:`Preview` in the :guilabel:`Manuscript Build` tool main window. :guilabel:`Preview` in the :guilabel:`Manuscript Build` tool main window.
Scene Separators Scene Separators
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
@@ -99,6 +102,19 @@ the desired separator text as the format. If the format is any piece of static t
be treated as a separator. be treated as a separator.
.. _a_manuscript_settings_head_hard:
Hard and Soft Scenes
^^^^^^^^^^^^^^^^^^^^
If you wish to distinguish between so-called soft and hard scene breaks, where a hard scene break
is understood as a scene break that changes point-of-view character, you can use the modified scene
heading format in your text. You can then give these headings a different formatting in the
:guilabel:`Headings` settings.
See :ref:`a_fmt_head` for more info on how to format headings in your text.
Output Settings Output Settings
--------------- ---------------
+6 -1
View File
@@ -68,7 +68,7 @@ correctly to produce the intended result. See :ref:`a_struct_heads` for more det
Heading level four. For novel documents, the level indicates the start of a new section. Section Heading level four. For novel documents, the level indicates the start of a new section. Section
titles can be replaced by separators or ignored completely when building the manuscript. titles can be replaced by separators or ignored completely when building the manuscript.
For headings level one and two, adding a ``!`` modifies its meaning: For headings level one through three, adding a ``!`` modifies its meaning:
``#! Title Text`` ``#! Title Text``
This tells the build tool that the level one heading is intended to be used for the novel's or This tells the build tool that the level one heading is intended to be used for the novel's or
@@ -81,6 +81,11 @@ For headings level one and two, adding a ``!`` modifies its meaning:
chapter numbers are being used. Such titles are useful for a prologue for instance. See chapter numbers are being used. Such titles are useful for a prologue for instance. See
:ref:`a_struct_heads_unnum` for more details. :ref:`a_struct_heads_unnum` for more details.
``###! Title Text``
This is an alternative scene heading that can be formatted differently in the
:guilabel:`Manuscript Build` tool. It is intended for separating "soft" and "hard" scene breaks.
Otherwise, it behaves identically to a regular scene heading.
.. note:: .. note::
The space after the ``#`` or ``!`` character is mandatory. The syntax highlighter will change The space after the ``#`` or ``!`` character is mandatory. The syntax highlighter will change
colour and font size when the heading is correctly formatted. colour and font size when the heading is correctly formatted.