diff --git a/docs/source/images/fig_build_settings_headings.png b/docs/source/images/fig_build_settings_headings.png index d5219361..a7262725 100644 Binary files a/docs/source/images/fig_build_settings_headings.png and b/docs/source/images/fig_build_settings_headings.png differ diff --git a/docs/source/int_howto.rst b/docs/source/int_howto.rst index 43f28601..fe5b22fa 100644 --- a/docs/source/int_howto.rst +++ b/docs/source/int_howto.rst @@ -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 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 =========== diff --git a/docs/source/project_manuscript.rst b/docs/source/project_manuscript.rst index 91af6245..9383079d 100644 --- a/docs/source/project_manuscript.rst +++ b/docs/source/project_manuscript.rst @@ -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. +.. _a_manuscript_settings_head: + 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 :guilabel:`Preview` in the :guilabel:`Manuscript Build` tool main window. + 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. +.. _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 --------------- diff --git a/docs/source/usage_format.rst b/docs/source/usage_format.rst index 9c4bf73f..f452c5fd 100644 --- a/docs/source/usage_format.rst +++ b/docs/source/usage_format.rst @@ -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 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`` 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 :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:: The space after the ``#`` or ``!`` character is mandatory. The syntax highlighter will change colour and font size when the heading is correctly formatted.