Move manuscript docs into new structure
@@ -49,10 +49,11 @@ storage for robustness.
|
|||||||
usage/advanced_formatting
|
usage/advanced_formatting
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: The Manuscript Tool
|
:caption: The User Interface
|
||||||
:hidden:
|
:hidden:
|
||||||
|
|
||||||
manuscript/introduction
|
user_interface/introduction
|
||||||
|
user_interface/manuscript
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: Additional Features
|
:caption: Additional Features
|
||||||
@@ -104,4 +105,3 @@ storage for robustness.
|
|||||||
|
|
||||||
project_overview
|
project_overview
|
||||||
project_structure
|
project_structure
|
||||||
project_manuscript
|
|
||||||
|
|||||||
@@ -102,7 +102,7 @@ Organising Your Text
|
|||||||
**Build Manuscript** tool will let you define a different format for scenes using the ``###``
|
**Build Manuscript** tool will let you define a different format for scenes using the ``###``
|
||||||
and ``###!`` heading codes when you generate your manuscript. You can for instance add the
|
and ``###!`` heading codes when you generate your manuscript. You can for instance add the
|
||||||
common "``* * *``" for hard breaks and select to hide soft scene breaks, which will just insert
|
common "``* * *``" for hard breaks and select to hide soft scene breaks, which will just insert
|
||||||
an empty paragraph in their place. See :ref:`a_manuscript_settings` for more details.
|
an empty paragraph in their place. See :ref:`docs_ui_manuscript_settings` for more details.
|
||||||
|
|
||||||
.. versionadded:: 2.4
|
.. versionadded:: 2.4
|
||||||
|
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ you want page breaks in other places, you have to specify them manually. See :re
|
|||||||
There are multiple options of how to process novel headings when building the manuscript. For
|
There are multiple options of how to process novel headings when building the manuscript. For
|
||||||
instance, chapter numbers can be applied automatically, and so can scene numbers if you want
|
instance, chapter numbers can be applied automatically, and so can scene numbers if you want
|
||||||
them in a draft manuscript. You can also insert point-of-view character names in chapter titles.
|
them in a draft manuscript. You can also insert point-of-view character names in chapter titles.
|
||||||
See the :ref:`a_manuscript` page for more details.
|
See the :ref:`docs_ui_manuscript` page for more details.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -127,9 +127,9 @@ the build tool to skip these chapters when adding numbers.
|
|||||||
Chapter Text
|
Chapter Text
|
||||||
|
|
||||||
There is a separate formatting feature for such chapter titles in the **Manuscript Build** tool as
|
There is a separate formatting feature for such chapter titles in the **Manuscript Build** tool as
|
||||||
well. See the :ref:`a_manuscript` page for more details. When building a document of a format that
|
well. See the :ref:`docs_ui_manuscript` page for more details. When building a document of a format
|
||||||
supports page breaks, also unnumbered chapters can have a page break added just like for normal
|
that supports page breaks, also unnumbered chapters can have a page break added just like for
|
||||||
chapters.
|
normal chapters.
|
||||||
|
|
||||||
|
|
||||||
.. _a_struct_heads_scenes:
|
.. _a_struct_heads_scenes:
|
||||||
|
|||||||
@@ -193,13 +193,13 @@ if you want to write your own custom processing script in for instance Python, a
|
|||||||
can be read into a Python dictionary with a couple of lines of code. The JSON file can be populated
|
can be read into a Python dictionary with a couple of lines of code. The JSON file can be populated
|
||||||
with either HTML formatted text, or with the raw text as typed it into the novel documents.
|
with either HTML formatted text, or with the raw text as typed it into the novel documents.
|
||||||
|
|
||||||
See :ref:`a_manuscript` for more details.
|
See :ref:`docs_ui_manuscript` for more details.
|
||||||
|
|
||||||
.. versionadded:: 2.1
|
.. versionadded:: 2.1
|
||||||
|
|
||||||
You can now define multiple build definitions in the **Build Manuscript** tool. This allows you
|
You can now define multiple build definitions in the **Build Manuscript** tool. This allows you
|
||||||
to define specific settings for various types of draft documents, outline documents, and
|
to define specific settings for various types of draft documents, outline documents, and
|
||||||
manuscript formats. See :ref:`a_manuscript` for more details.
|
manuscript formats. See :ref:`docs_ui_manuscript` for more details.
|
||||||
|
|
||||||
|
|
||||||
.. _a_breakdown_storage:
|
.. _a_breakdown_storage:
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 63 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 101 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 121 KiB After Width: | Height: | Size: 121 KiB |
@@ -1,4 +1,4 @@
|
|||||||
.. _a_manuscript:
|
.. _docs_ui_manuscript:
|
||||||
|
|
||||||
***********************
|
***********************
|
||||||
Building the Manuscript
|
Building the Manuscript
|
||||||
@@ -17,7 +17,7 @@ activate it from the sidebar, the **Tools** menu, or by pressing :kbd:`F5`.
|
|||||||
functionality.
|
functionality.
|
||||||
|
|
||||||
|
|
||||||
.. _a_manuscript_main:
|
.. _docs_ui_manuscript_main:
|
||||||
|
|
||||||
The Manuscript Build Tool
|
The Manuscript Build Tool
|
||||||
=========================
|
=========================
|
||||||
@@ -50,7 +50,7 @@ than what's available in the project tree since they are counted *after formatti
|
|||||||
For a detailed description on how they are counted, see :ref:`docs_more_counting`.
|
For a detailed description on how they are counted, see :ref:`docs_more_counting`.
|
||||||
|
|
||||||
|
|
||||||
.. _a_manuscript_settings:
|
.. _docs_ui_manuscript_settings:
|
||||||
|
|
||||||
Build Settings
|
Build Settings
|
||||||
==============
|
==============
|
||||||
@@ -87,7 +87,7 @@ 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:
|
.. _docs_ui_manuscript_head:
|
||||||
|
|
||||||
Formatting Headings
|
Formatting Headings
|
||||||
-------------------
|
-------------------
|
||||||
@@ -127,7 +127,7 @@ 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:
|
.. _docs_ui_manuscript_head_hard:
|
||||||
|
|
||||||
Hard and Soft Scenes
|
Hard and Soft Scenes
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
@@ -147,7 +147,7 @@ control a number of other settings for the output. Some of these only apply to s
|
|||||||
formats, which is indicated by the section headings on the settings pages.
|
formats, which is indicated by the section headings on the settings pages.
|
||||||
|
|
||||||
|
|
||||||
.. _a_manuscript_build:
|
.. _docs_ui_manuscript_build:
|
||||||
|
|
||||||
Building Manuscript Documents
|
Building Manuscript Documents
|
||||||
=============================
|
=============================
|
||||||
@@ -224,7 +224,7 @@ These files are mainly intended for scripted post-processing for those who want
|
|||||||
file can be imported directly into a Python dict object or a PHP array, to mentions a few options.
|
file can be imported directly into a Python dict object or a PHP array, to mentions a few options.
|
||||||
|
|
||||||
|
|
||||||
.. _a_manuscript_print:
|
.. _docs_ui_manuscript_print:
|
||||||
|
|
||||||
Printing
|
Printing
|
||||||
========
|
========
|
||||||