[TASK] Create reference section in the menu

TYPO3-Documentation · Jul 28, 2024 · d2ece6e · d2ece6e
1 parent 84a6e86
commit d2ece6e
Show file tree

Hide file tree

Showing 54 changed files with 54 additions and 31 deletions.
diff --git a/Documentation/GeneralConventions/Index.rst b/Documentation/GeneralConventions/Index.rst
@@ -104,8 +104,6 @@ be found in the subchapters.
     ReviewPolicy
     ContentStyleGuide
     Glossary
-    FileStructure
-    GuidesXml
     Format
     CodingGuidelines
     GuidelinesForImages

diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -96,6 +96,15 @@ reStructuredText (reST).
     GeneralConventions/Index
     WritingReST/Index
 
+
+..  toctree::
+    :hidden:
+    :caption: REFERENCE
+    :glob:
+
+    Reference/*
+    Reference/ReStructuredText/Index
+
 ..  toctree::
     :hidden:
     :caption: HOWTOS

diff --git a/Documentation/Reference/DockerRendering.rst b/Documentation/Reference/DockerRendering.rst
@@ -0,0 +1,14 @@
+.. include:: /Includes.rst.txt
+
+.. _rendering:
+
+===================
+Rendering container
+===================
+
+For local rendering you can use the following command in the directory that
+contains the :path:`Documentation` folder:
+
+..  include:: /_Includes/_LocalRendering.rst.txt
+
+..  todo: Document rendering container options here
diff --git a/...tion/GeneralConventions/FileStructure.rst → Documentation/Reference/FileStructure.rst b/...tion/GeneralConventions/FileStructure.rst → Documentation/Reference/FileStructure.rst
diff --git a/...entation/GeneralConventions/GuidesXml.rst → Documentation/Reference/GuidesXml.rst b/...entation/GeneralConventions/GuidesXml.rst → Documentation/Reference/GuidesXml.rst
diff --git a/...WritingReST/Reference/Code/Codeblocks.rst → ...ence/ReStructuredText/Code/Codeblocks.rst b/...WritingReST/Reference/Code/Codeblocks.rst → ...ence/ReStructuredText/Code/Codeblocks.rst
diff --git a/...on/WritingReST/Reference/Code/Confval.rst → ...ference/ReStructuredText/Code/Confval.rst b/...on/WritingReST/Reference/Code/Confval.rst → ...ference/ReStructuredText/Code/Confval.rst
diff --git a/...tion/WritingReST/Reference/Code/Index.rst → ...Reference/ReStructuredText/Code/Index.rst b/...tion/WritingReST/Reference/Code/Index.rst → ...Reference/ReStructuredText/Code/Index.rst
diff --git a/...WritingReST/Reference/Code/InlineCode.rst → ...ence/ReStructuredText/Code/InlineCode.rst b/...WritingReST/Reference/Code/InlineCode.rst → ...ence/ReStructuredText/Code/InlineCode.rst
diff --git a/.../WritingReST/Reference/Code/Phpdomain.rst → ...rence/ReStructuredText/Code/Phpdomain.rst b/.../WritingReST/Reference/Code/Phpdomain.rst → ...rence/ReStructuredText/Code/Phpdomain.rst
diff --git a/...itingReST/Reference/Content/Accordion.rst → ...ce/ReStructuredText/Content/Accordion.rst b/...itingReST/Reference/Content/Accordion.rst → ...ce/ReStructuredText/Content/Accordion.rst
diff --git a/...ingReST/Reference/Content/Admonitions.rst → .../ReStructuredText/Content/Admonitions.rst b/...ingReST/Reference/Content/Admonitions.rst → .../ReStructuredText/Content/Admonitions.rst
diff --git a/...tingReST/Reference/Content/BoldItalic.rst → ...e/ReStructuredText/Content/BoldItalic.rst b/...tingReST/Reference/Content/BoldItalic.rst → ...e/ReStructuredText/Content/BoldItalic.rst
diff --git a/...n/WritingReST/Reference/Content/Cards.rst → ...erence/ReStructuredText/Content/Cards.rst b/...n/WritingReST/Reference/Content/Cards.rst → ...erence/ReStructuredText/Content/Cards.rst
diff --git a/...ritingReST/Reference/Content/Comments.rst → ...nce/ReStructuredText/Content/Comments.rst b/...ritingReST/Reference/Content/Comments.rst → ...nce/ReStructuredText/Content/Comments.rst
diff --git a/...n/WritingReST/Reference/Content/Index.rst → ...erence/ReStructuredText/Content/Index.rst b/...n/WritingReST/Reference/Content/Index.rst → ...erence/ReStructuredText/Content/Index.rst
diff --git a/...n/WritingReST/Reference/Content/Links.rst → ...erence/ReStructuredText/Content/Links.rst b/...n/WritingReST/Reference/Content/Links.rst → ...erence/ReStructuredText/Content/Links.rst
diff --git a/...T/Reference/Content/SpecialCharacters.rst → ...ucturedText/Content/SpecialCharacters.rst b/...T/Reference/Content/SpecialCharacters.rst → ...ucturedText/Content/SpecialCharacters.rst
diff --git a/.../WritingReST/Reference/Content/Tables.rst → ...rence/ReStructuredText/Content/Tables.rst b/.../WritingReST/Reference/Content/Tables.rst → ...rence/ReStructuredText/Content/Tables.rst
diff --git a/...on/WritingReST/Reference/Content/Tabs.rst → ...ference/ReStructuredText/Content/Tabs.rst b/...on/WritingReST/Reference/Content/Tabs.rst → ...ference/ReStructuredText/Content/Tabs.rst
diff --git a/...ritingReST/Reference/Content/Versions.rst → ...nce/ReStructuredText/Content/Versions.rst b/...ritingReST/Reference/Content/Versions.rst → ...nce/ReStructuredText/Content/Versions.rst
diff --git a/...tingReST/Reference/Content/ViewHelper.rst → ...e/ReStructuredText/Content/ViewHelper.rst b/...tingReST/Reference/Content/ViewHelper.rst → ...e/ReStructuredText/Content/ViewHelper.rst
diff --git a/...gReST/Reference/Content/YoutubeVideos.rst → ...eStructuredText/Content/YoutubeVideos.rst b/...gReST/Reference/Content/YoutubeVideos.rst → ...eStructuredText/Content/YoutubeVideos.rst
diff --git a/...ence/Content/_ViewHelper/_Content.rst.txt → ...Text/Content/_ViewHelper/_Content.rst.txt b/...ence/Content/_ViewHelper/_Content.rst.txt → ...Text/Content/_ViewHelper/_Content.rst.txt
diff --git a/...ence/Content/_ViewHelper/_NoIndex.rst.txt → ...Text/Content/_ViewHelper/_NoIndex.rst.txt b/...ence/Content/_ViewHelper/_NoIndex.rst.txt → ...Text/Content/_ViewHelper/_NoIndex.rst.txt
diff --git a/...rence/Content/_ViewHelper/_SortBy.rst.txt → ...dText/Content/_ViewHelper/_SortBy.rst.txt b/...rence/Content/_ViewHelper/_SortBy.rst.txt → ...dText/Content/_ViewHelper/_SortBy.rst.txt
diff --git a/...rence/Content/_ViewHelper/_Source.rst.txt → ...dText/Content/_ViewHelper/_Source.rst.txt b/...rence/Content/_ViewHelper/_Source.rst.txt → ...dText/Content/_ViewHelper/_Source.rst.txt
diff --git a/..._ViewHelper/_global_viewhelpers_demo.json → ..._ViewHelper/_global_viewhelpers_demo.json b/..._ViewHelper/_global_viewhelpers_demo.json → ..._ViewHelper/_global_viewhelpers_demo.json
diff --git a/...itingReST/Reference/Graphics/Diagrams.rst → ...ce/ReStructuredText/Graphics/Diagrams.rst b/...itingReST/Reference/Graphics/Diagrams.rst → ...ce/ReStructuredText/Graphics/Diagrams.rst
diff --git a/...WritingReST/Reference/Graphics/Images.rst → ...ence/ReStructuredText/Graphics/Images.rst b/...WritingReST/Reference/Graphics/Images.rst → ...ence/ReStructuredText/Graphics/Images.rst
diff --git a/.../WritingReST/Reference/Graphics/Index.rst → ...rence/ReStructuredText/Graphics/Index.rst b/.../WritingReST/Reference/Graphics/Index.rst → ...rence/ReStructuredText/Graphics/Index.rst
diff --git a/.../Reference/Graphics/_complex_uml.plantuml → ...cturedText/Graphics/_complex_uml.plantuml b/.../Reference/Graphics/_complex_uml.plantuml → ...cturedText/Graphics/_complex_uml.plantuml
diff --git a/...mentation/WritingReST/Reference/Index.rst → ...tion/Reference/ReStructuredText/Index.rst b/...mentation/WritingReST/Reference/Index.rst → ...tion/Reference/ReStructuredText/Index.rst
@@ -1,10 +1,12 @@
+:navigation-title: reStructuredText
+
 ..  include:: /Includes.rst.txt
 ..  index:: reST; Reference
 ..  _rest-reference:
 
-===========================
-Reference: reStructuredText
-===========================
+==========================
+reStructuredText Reference
+==========================
 
 ..  toctree::
     :titlesonly:

diff --git a/...itingReST/Reference/Lists/BignumLists.rst → ...ce/ReStructuredText/Lists/BignumLists.rst b/...itingReST/Reference/Lists/BignumLists.rst → ...ce/ReStructuredText/Lists/BignumLists.rst
diff --git a/...itingReST/Reference/Lists/BulletLists.rst → ...ce/ReStructuredText/Lists/BulletLists.rst b/...itingReST/Reference/Lists/BulletLists.rst → ...ce/ReStructuredText/Lists/BulletLists.rst
diff --git a/...gReST/Reference/Lists/DefinitionLists.rst → ...eStructuredText/Lists/DefinitionLists.rst b/...gReST/Reference/Lists/DefinitionLists.rst → ...eStructuredText/Lists/DefinitionLists.rst
diff --git a/...ingReST/Reference/Lists/DirectoryTree.rst → .../ReStructuredText/Lists/DirectoryTree.rst b/...ingReST/Reference/Lists/DirectoryTree.rst → .../ReStructuredText/Lists/DirectoryTree.rst
diff --git a/...ion/WritingReST/Reference/Lists/Index.rst → ...eference/ReStructuredText/Lists/Index.rst b/...ion/WritingReST/Reference/Lists/Index.rst → ...eference/ReStructuredText/Lists/Index.rst
diff --git a/...ST/Reference/Lists/ListItemsAsButtons.rst → ...ructuredText/Lists/ListItemsAsButtons.rst b/...ST/Reference/Lists/ListItemsAsButtons.rst → ...ructuredText/Lists/ListItemsAsButtons.rst
diff --git a/...ingReST/Reference/Lists/NumberedLists.rst → .../ReStructuredText/Lists/NumberedLists.rst b/...ingReST/Reference/Lists/NumberedLists.rst → .../ReStructuredText/Lists/NumberedLists.rst
diff --git a/...itingReST/Reference/Menus/ContentMenu.rst → ...ce/ReStructuredText/Menus/ContentMenu.rst b/...itingReST/Reference/Menus/ContentMenu.rst → ...ce/ReStructuredText/Menus/ContentMenu.rst
diff --git a/...T/Reference/Menus/HeadlinesAndSection.rst → ...ucturedText/Menus/HeadlinesAndSection.rst b/...T/Reference/Menus/HeadlinesAndSection.rst → ...ucturedText/Menus/HeadlinesAndSection.rst
diff --git a/...ngReST/Reference/Menus/IncludingFiles.rst → ...ReStructuredText/Menus/IncludingFiles.rst b/...ngReST/Reference/Menus/IncludingFiles.rst → ...ReStructuredText/Menus/IncludingFiles.rst
diff --git a/...ion/WritingReST/Reference/Menus/Index.rst → ...eference/ReStructuredText/Menus/Index.rst b/...ion/WritingReST/Reference/Menus/Index.rst → ...eference/ReStructuredText/Menus/Index.rst
diff --git a/...ingReST/Reference/Menus/MenuHierarchy.rst → .../ReStructuredText/Menus/MenuHierarchy.rst b/...ingReST/Reference/Menus/MenuHierarchy.rst → .../ReStructuredText/Menus/MenuHierarchy.rst
diff --git a/...gReST/Reference/Menus/NavigationTitle.rst → ...eStructuredText/Menus/NavigationTitle.rst b/...gReST/Reference/Menus/NavigationTitle.rst → ...eStructuredText/Menus/NavigationTitle.rst
diff --git a/...n/WritingReST/Reference/Menus/Orphans.rst → ...erence/ReStructuredText/Menus/Orphans.rst b/...n/WritingReST/Reference/Menus/Orphans.rst → ...erence/ReStructuredText/Menus/Orphans.rst
diff --git a/...n/WritingReST/Reference/Menus/Sidebar.rst → ...erence/ReStructuredText/Menus/Sidebar.rst b/...n/WritingReST/Reference/Menus/Sidebar.rst → ...erence/ReStructuredText/Menus/Sidebar.rst
diff --git a/...Reference/Menus/_Include/_Content.rst.txt → ...turedText/Menus/_Include/_Content.rst.txt b/...Reference/Menus/_Include/_Content.rst.txt → ...turedText/Menus/_Include/_Content.rst.txt
diff --git a/...rence/Menus/_Include/_ShowButtons.rst.txt → ...dText/Menus/_Include/_ShowButtons.rst.txt b/...rence/Menus/_Include/_ShowButtons.rst.txt → ...dText/Menus/_Include/_ShowButtons.rst.txt
diff --git a/...ion/GeneralConventions/_guides-simple.xml → Documentation/Reference/_guides-simple.xml b/...ion/GeneralConventions/_guides-simple.xml → Documentation/Reference/_guides-simple.xml
diff --git a/Documentation/RenderingDocs/Index.rst b/Documentation/RenderingDocs/Index.rst
@@ -42,31 +42,7 @@ Make sure that `Docker <https://www.docker.com/>`__ is installed on your system.
     the mentioned containers by replacing all :bash:`docker` commands in the
     following steps with :bash:`podman`.
 
-..  tabs::
-
-    ..  group-tab:: Linux
-
-        ..  code-block:: bash
-
-            mkdir -p Documentation-GENERATED-temp
-            docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
-            xdg-open "Documentation-GENERATED-temp/Index.html"
-
-    .. group-tab:: MacOS
-
-        ..  code-block:: bash
-
-            mkdir -p Documentation-GENERATED-temp
-            docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
-            open "Documentation-GENERATED-temp/Index.html"
-
-    ..  group-tab:: Windows
-
-        ..  code-block:: powershell
-
-            New-Item -ItemType Directory -Force -Path ".\Documentation-GENERATED-temp"
-            docker run --rm --pull always -v ${PWD}:/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
-            start "Documentation-GENERATED-temp/Index.html"
+..  include:: /_Includes/_LocalRendering.rst.txt
 
 ..  _rendering-wysiwyg:
 

diff --git a/Documentation/WritingReST/Index.rst b/Documentation/WritingReST/Index.rst
@@ -33,4 +33,3 @@ available. For more information, see other resources, such as:
     Introduction
     BasicRestSyntax
     CheatSheet
-    Reference/Index
diff --git a/Documentation/_Includes/_LocalRendering.rst.txt b/Documentation/_Includes/_LocalRendering.rst.txt
@@ -0,0 +1,25 @@
+..  tabs::
+
+    ..  group-tab:: Linux
+
+        ..  code-block:: bash
+
+            mkdir -p Documentation-GENERATED-temp
+            docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
+            xdg-open "Documentation-GENERATED-temp/Index.html"
+
+    .. group-tab:: MacOS
+
+        ..  code-block:: bash
+
+            mkdir -p Documentation-GENERATED-temp
+            docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
+            open "Documentation-GENERATED-temp/Index.html"
+
+    ..  group-tab:: Windows
+
+        ..  code-block:: powershell
+
+            New-Item -ItemType Directory -Force -Path ".\Documentation-GENERATED-temp"
+            docker run --rm --pull always -v ${PWD}:/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
+            start "Documentation-GENERATED-temp/Index.html"