diff --git a/docs/source/index.rst b/docs/source/index.rst index 91154b61..8a3d8d53 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -49,10 +49,11 @@ storage for robustness. usage/advanced_formatting .. toctree:: - :caption: The Manuscript Tool + :caption: The User Interface :hidden: - manuscript/introduction + user_interface/introduction + user_interface/manuscript .. toctree:: :caption: Additional Features @@ -104,4 +105,3 @@ storage for robustness. project_overview project_structure - project_manuscript diff --git a/docs/source/more/howto.rst b/docs/source/more/howto.rst index 57624063..d63d6569 100644 --- a/docs/source/more/howto.rst +++ b/docs/source/more/howto.rst @@ -102,7 +102,7 @@ Organising Your Text **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 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 diff --git a/docs/source/project_structure.rst b/docs/source/project_structure.rst index 5e3affc4..273525fc 100644 --- a/docs/source/project_structure.rst +++ b/docs/source/project_structure.rst @@ -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 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. - 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 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 -supports page breaks, also unnumbered chapters can have a page break added just like for normal -chapters. +well. See the :ref:`docs_ui_manuscript` page for more details. When building a document of a format +that supports page breaks, also unnumbered chapters can have a page break added just like for +normal chapters. .. _a_struct_heads_scenes: diff --git a/docs/source/usage_breakdown.rst b/docs/source/usage_breakdown.rst index 3371cc3e..d1443924 100644 --- a/docs/source/usage_breakdown.rst +++ b/docs/source/usage_breakdown.rst @@ -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 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 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 - manuscript formats. See :ref:`a_manuscript` for more details. + manuscript formats. See :ref:`docs_ui_manuscript` for more details. .. _a_breakdown_storage: diff --git a/docs/source/images/fig_build_build.png b/docs/source/user_interface/images/fig_build_build.png similarity index 100% rename from docs/source/images/fig_build_build.png rename to docs/source/user_interface/images/fig_build_build.png diff --git a/docs/source/images/fig_build_settings_headings.png b/docs/source/user_interface/images/fig_build_settings_headings.png similarity index 100% rename from docs/source/images/fig_build_settings_headings.png rename to docs/source/user_interface/images/fig_build_settings_headings.png diff --git a/docs/source/images/fig_build_settings_selections.png b/docs/source/user_interface/images/fig_build_settings_selections.png similarity index 100% rename from docs/source/images/fig_build_settings_selections.png rename to docs/source/user_interface/images/fig_build_settings_selections.png diff --git a/docs/source/images/fig_manuscript_build.png b/docs/source/user_interface/images/fig_manuscript_build.png similarity index 100% rename from docs/source/images/fig_manuscript_build.png rename to docs/source/user_interface/images/fig_manuscript_build.png diff --git a/docs/source/images/fig_manuscript_build_outline.png b/docs/source/user_interface/images/fig_manuscript_build_outline.png similarity index 100% rename from docs/source/images/fig_manuscript_build_outline.png rename to docs/source/user_interface/images/fig_manuscript_build_outline.png diff --git a/docs/source/manuscript/introduction.rst b/docs/source/user_interface/introduction.rst similarity index 100% rename from docs/source/manuscript/introduction.rst rename to docs/source/user_interface/introduction.rst diff --git a/docs/source/project_manuscript.rst b/docs/source/user_interface/manuscript.rst similarity index 97% rename from docs/source/project_manuscript.rst rename to docs/source/user_interface/manuscript.rst index 963a5865..d4cb5399 100644 --- a/docs/source/project_manuscript.rst +++ b/docs/source/user_interface/manuscript.rst @@ -1,4 +1,4 @@ -.. _a_manuscript: +.. _docs_ui_manuscript: *********************** Building the Manuscript @@ -17,7 +17,7 @@ activate it from the sidebar, the **Tools** menu, or by pressing :kbd:`F5`. functionality. -.. _a_manuscript_main: +.. _docs_ui_manuscript_main: 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`. -.. _a_manuscript_settings: +.. _docs_ui_manuscript_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. -.. _a_manuscript_settings_head: +.. _docs_ui_manuscript_head: 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. -.. _a_manuscript_settings_head_hard: +.. _docs_ui_manuscript_head_hard: 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. -.. _a_manuscript_build: +.. _docs_ui_manuscript_build: 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. -.. _a_manuscript_print: +.. _docs_ui_manuscript_print: Printing ========