diff --git a/Documentation/GeneralConventions/Index.rst b/Documentation/GeneralConventions/Index.rst index a271ae7f..02327bd2 100644 --- 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 index ea783800..3a6e9d73 100644 --- 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 new file mode 100644 index 00000000..be476baa --- /dev/null +++ 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/Documentation/GeneralConventions/FileStructure.rst b/Documentation/Reference/FileStructure.rst similarity index 100% rename from Documentation/GeneralConventions/FileStructure.rst rename to Documentation/Reference/FileStructure.rst diff --git a/Documentation/GeneralConventions/GuidesXml.rst b/Documentation/Reference/GuidesXml.rst similarity index 100% rename from Documentation/GeneralConventions/GuidesXml.rst rename to Documentation/Reference/GuidesXml.rst diff --git a/Documentation/WritingReST/Reference/Code/Codeblocks.rst b/Documentation/Reference/ReStructuredText/Code/Codeblocks.rst similarity index 100% rename from Documentation/WritingReST/Reference/Code/Codeblocks.rst rename to Documentation/Reference/ReStructuredText/Code/Codeblocks.rst diff --git a/Documentation/WritingReST/Reference/Code/Confval.rst b/Documentation/Reference/ReStructuredText/Code/Confval.rst similarity index 100% rename from Documentation/WritingReST/Reference/Code/Confval.rst rename to Documentation/Reference/ReStructuredText/Code/Confval.rst diff --git a/Documentation/WritingReST/Reference/Code/Index.rst b/Documentation/Reference/ReStructuredText/Code/Index.rst similarity index 100% rename from Documentation/WritingReST/Reference/Code/Index.rst rename to Documentation/Reference/ReStructuredText/Code/Index.rst diff --git a/Documentation/WritingReST/Reference/Code/InlineCode.rst b/Documentation/Reference/ReStructuredText/Code/InlineCode.rst similarity index 100% rename from Documentation/WritingReST/Reference/Code/InlineCode.rst rename to Documentation/Reference/ReStructuredText/Code/InlineCode.rst diff --git a/Documentation/WritingReST/Reference/Code/Phpdomain.rst b/Documentation/Reference/ReStructuredText/Code/Phpdomain.rst similarity index 100% rename from Documentation/WritingReST/Reference/Code/Phpdomain.rst rename to Documentation/Reference/ReStructuredText/Code/Phpdomain.rst diff --git a/Documentation/WritingReST/Reference/Content/Accordion.rst b/Documentation/Reference/ReStructuredText/Content/Accordion.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Accordion.rst rename to Documentation/Reference/ReStructuredText/Content/Accordion.rst diff --git a/Documentation/WritingReST/Reference/Content/Admonitions.rst b/Documentation/Reference/ReStructuredText/Content/Admonitions.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Admonitions.rst rename to Documentation/Reference/ReStructuredText/Content/Admonitions.rst diff --git a/Documentation/WritingReST/Reference/Content/BoldItalic.rst b/Documentation/Reference/ReStructuredText/Content/BoldItalic.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/BoldItalic.rst rename to Documentation/Reference/ReStructuredText/Content/BoldItalic.rst diff --git a/Documentation/WritingReST/Reference/Content/Cards.rst b/Documentation/Reference/ReStructuredText/Content/Cards.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Cards.rst rename to Documentation/Reference/ReStructuredText/Content/Cards.rst diff --git a/Documentation/WritingReST/Reference/Content/Comments.rst b/Documentation/Reference/ReStructuredText/Content/Comments.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Comments.rst rename to Documentation/Reference/ReStructuredText/Content/Comments.rst diff --git a/Documentation/WritingReST/Reference/Content/Index.rst b/Documentation/Reference/ReStructuredText/Content/Index.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Index.rst rename to Documentation/Reference/ReStructuredText/Content/Index.rst diff --git a/Documentation/WritingReST/Reference/Content/Links.rst b/Documentation/Reference/ReStructuredText/Content/Links.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Links.rst rename to Documentation/Reference/ReStructuredText/Content/Links.rst diff --git a/Documentation/WritingReST/Reference/Content/SpecialCharacters.rst b/Documentation/Reference/ReStructuredText/Content/SpecialCharacters.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/SpecialCharacters.rst rename to Documentation/Reference/ReStructuredText/Content/SpecialCharacters.rst diff --git a/Documentation/WritingReST/Reference/Content/Tables.rst b/Documentation/Reference/ReStructuredText/Content/Tables.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Tables.rst rename to Documentation/Reference/ReStructuredText/Content/Tables.rst diff --git a/Documentation/WritingReST/Reference/Content/Tabs.rst b/Documentation/Reference/ReStructuredText/Content/Tabs.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Tabs.rst rename to Documentation/Reference/ReStructuredText/Content/Tabs.rst diff --git a/Documentation/WritingReST/Reference/Content/Versions.rst b/Documentation/Reference/ReStructuredText/Content/Versions.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/Versions.rst rename to Documentation/Reference/ReStructuredText/Content/Versions.rst diff --git a/Documentation/WritingReST/Reference/Content/ViewHelper.rst b/Documentation/Reference/ReStructuredText/Content/ViewHelper.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/ViewHelper.rst rename to Documentation/Reference/ReStructuredText/Content/ViewHelper.rst diff --git a/Documentation/WritingReST/Reference/Content/YoutubeVideos.rst b/Documentation/Reference/ReStructuredText/Content/YoutubeVideos.rst similarity index 100% rename from Documentation/WritingReST/Reference/Content/YoutubeVideos.rst rename to Documentation/Reference/ReStructuredText/Content/YoutubeVideos.rst diff --git a/Documentation/WritingReST/Reference/Content/_ViewHelper/_Content.rst.txt b/Documentation/Reference/ReStructuredText/Content/_ViewHelper/_Content.rst.txt similarity index 100% rename from Documentation/WritingReST/Reference/Content/_ViewHelper/_Content.rst.txt rename to Documentation/Reference/ReStructuredText/Content/_ViewHelper/_Content.rst.txt diff --git a/Documentation/WritingReST/Reference/Content/_ViewHelper/_NoIndex.rst.txt b/Documentation/Reference/ReStructuredText/Content/_ViewHelper/_NoIndex.rst.txt similarity index 100% rename from Documentation/WritingReST/Reference/Content/_ViewHelper/_NoIndex.rst.txt rename to Documentation/Reference/ReStructuredText/Content/_ViewHelper/_NoIndex.rst.txt diff --git a/Documentation/WritingReST/Reference/Content/_ViewHelper/_SortBy.rst.txt b/Documentation/Reference/ReStructuredText/Content/_ViewHelper/_SortBy.rst.txt similarity index 100% rename from Documentation/WritingReST/Reference/Content/_ViewHelper/_SortBy.rst.txt rename to Documentation/Reference/ReStructuredText/Content/_ViewHelper/_SortBy.rst.txt diff --git a/Documentation/WritingReST/Reference/Content/_ViewHelper/_Source.rst.txt b/Documentation/Reference/ReStructuredText/Content/_ViewHelper/_Source.rst.txt similarity index 100% rename from Documentation/WritingReST/Reference/Content/_ViewHelper/_Source.rst.txt rename to Documentation/Reference/ReStructuredText/Content/_ViewHelper/_Source.rst.txt diff --git a/Documentation/WritingReST/Reference/Content/_ViewHelper/_global_viewhelpers_demo.json b/Documentation/Reference/ReStructuredText/Content/_ViewHelper/_global_viewhelpers_demo.json similarity index 100% rename from Documentation/WritingReST/Reference/Content/_ViewHelper/_global_viewhelpers_demo.json rename to Documentation/Reference/ReStructuredText/Content/_ViewHelper/_global_viewhelpers_demo.json diff --git a/Documentation/WritingReST/Reference/Graphics/Diagrams.rst b/Documentation/Reference/ReStructuredText/Graphics/Diagrams.rst similarity index 100% rename from Documentation/WritingReST/Reference/Graphics/Diagrams.rst rename to Documentation/Reference/ReStructuredText/Graphics/Diagrams.rst diff --git a/Documentation/WritingReST/Reference/Graphics/Images.rst b/Documentation/Reference/ReStructuredText/Graphics/Images.rst similarity index 100% rename from Documentation/WritingReST/Reference/Graphics/Images.rst rename to Documentation/Reference/ReStructuredText/Graphics/Images.rst diff --git a/Documentation/WritingReST/Reference/Graphics/Index.rst b/Documentation/Reference/ReStructuredText/Graphics/Index.rst similarity index 100% rename from Documentation/WritingReST/Reference/Graphics/Index.rst rename to Documentation/Reference/ReStructuredText/Graphics/Index.rst diff --git a/Documentation/WritingReST/Reference/Graphics/_complex_uml.plantuml b/Documentation/Reference/ReStructuredText/Graphics/_complex_uml.plantuml similarity index 100% rename from Documentation/WritingReST/Reference/Graphics/_complex_uml.plantuml rename to Documentation/Reference/ReStructuredText/Graphics/_complex_uml.plantuml diff --git a/Documentation/WritingReST/Reference/Index.rst b/Documentation/Reference/ReStructuredText/Index.rst similarity index 54% rename from Documentation/WritingReST/Reference/Index.rst rename to Documentation/Reference/ReStructuredText/Index.rst index 9dda0465..9f858975 100644 --- a/Documentation/WritingReST/Reference/Index.rst +++ b/Documentation/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/Documentation/WritingReST/Reference/Lists/BignumLists.rst b/Documentation/Reference/ReStructuredText/Lists/BignumLists.rst similarity index 100% rename from Documentation/WritingReST/Reference/Lists/BignumLists.rst rename to Documentation/Reference/ReStructuredText/Lists/BignumLists.rst diff --git a/Documentation/WritingReST/Reference/Lists/BulletLists.rst b/Documentation/Reference/ReStructuredText/Lists/BulletLists.rst similarity index 100% rename from Documentation/WritingReST/Reference/Lists/BulletLists.rst rename to Documentation/Reference/ReStructuredText/Lists/BulletLists.rst diff --git a/Documentation/WritingReST/Reference/Lists/DefinitionLists.rst b/Documentation/Reference/ReStructuredText/Lists/DefinitionLists.rst similarity index 100% rename from Documentation/WritingReST/Reference/Lists/DefinitionLists.rst rename to Documentation/Reference/ReStructuredText/Lists/DefinitionLists.rst diff --git a/Documentation/WritingReST/Reference/Lists/DirectoryTree.rst b/Documentation/Reference/ReStructuredText/Lists/DirectoryTree.rst similarity index 100% rename from Documentation/WritingReST/Reference/Lists/DirectoryTree.rst rename to Documentation/Reference/ReStructuredText/Lists/DirectoryTree.rst diff --git a/Documentation/WritingReST/Reference/Lists/Index.rst b/Documentation/Reference/ReStructuredText/Lists/Index.rst similarity index 100% rename from Documentation/WritingReST/Reference/Lists/Index.rst rename to Documentation/Reference/ReStructuredText/Lists/Index.rst diff --git a/Documentation/WritingReST/Reference/Lists/ListItemsAsButtons.rst b/Documentation/Reference/ReStructuredText/Lists/ListItemsAsButtons.rst similarity index 100% rename from Documentation/WritingReST/Reference/Lists/ListItemsAsButtons.rst rename to Documentation/Reference/ReStructuredText/Lists/ListItemsAsButtons.rst diff --git a/Documentation/WritingReST/Reference/Lists/NumberedLists.rst b/Documentation/Reference/ReStructuredText/Lists/NumberedLists.rst similarity index 100% rename from Documentation/WritingReST/Reference/Lists/NumberedLists.rst rename to Documentation/Reference/ReStructuredText/Lists/NumberedLists.rst diff --git a/Documentation/WritingReST/Reference/Menus/ContentMenu.rst b/Documentation/Reference/ReStructuredText/Menus/ContentMenu.rst similarity index 100% rename from Documentation/WritingReST/Reference/Menus/ContentMenu.rst rename to Documentation/Reference/ReStructuredText/Menus/ContentMenu.rst diff --git a/Documentation/WritingReST/Reference/Menus/HeadlinesAndSection.rst b/Documentation/Reference/ReStructuredText/Menus/HeadlinesAndSection.rst similarity index 100% rename from Documentation/WritingReST/Reference/Menus/HeadlinesAndSection.rst rename to Documentation/Reference/ReStructuredText/Menus/HeadlinesAndSection.rst diff --git a/Documentation/WritingReST/Reference/Menus/IncludingFiles.rst b/Documentation/Reference/ReStructuredText/Menus/IncludingFiles.rst similarity index 100% rename from Documentation/WritingReST/Reference/Menus/IncludingFiles.rst rename to Documentation/Reference/ReStructuredText/Menus/IncludingFiles.rst diff --git a/Documentation/WritingReST/Reference/Menus/Index.rst b/Documentation/Reference/ReStructuredText/Menus/Index.rst similarity index 100% rename from Documentation/WritingReST/Reference/Menus/Index.rst rename to Documentation/Reference/ReStructuredText/Menus/Index.rst diff --git a/Documentation/WritingReST/Reference/Menus/MenuHierarchy.rst b/Documentation/Reference/ReStructuredText/Menus/MenuHierarchy.rst similarity index 100% rename from Documentation/WritingReST/Reference/Menus/MenuHierarchy.rst rename to Documentation/Reference/ReStructuredText/Menus/MenuHierarchy.rst diff --git a/Documentation/WritingReST/Reference/Menus/NavigationTitle.rst b/Documentation/Reference/ReStructuredText/Menus/NavigationTitle.rst similarity index 100% rename from Documentation/WritingReST/Reference/Menus/NavigationTitle.rst rename to Documentation/Reference/ReStructuredText/Menus/NavigationTitle.rst diff --git a/Documentation/WritingReST/Reference/Menus/Orphans.rst b/Documentation/Reference/ReStructuredText/Menus/Orphans.rst similarity index 100% rename from Documentation/WritingReST/Reference/Menus/Orphans.rst rename to Documentation/Reference/ReStructuredText/Menus/Orphans.rst diff --git a/Documentation/WritingReST/Reference/Menus/Sidebar.rst b/Documentation/Reference/ReStructuredText/Menus/Sidebar.rst similarity index 100% rename from Documentation/WritingReST/Reference/Menus/Sidebar.rst rename to Documentation/Reference/ReStructuredText/Menus/Sidebar.rst diff --git a/Documentation/WritingReST/Reference/Menus/_Include/_Content.rst.txt b/Documentation/Reference/ReStructuredText/Menus/_Include/_Content.rst.txt similarity index 100% rename from Documentation/WritingReST/Reference/Menus/_Include/_Content.rst.txt rename to Documentation/Reference/ReStructuredText/Menus/_Include/_Content.rst.txt diff --git a/Documentation/WritingReST/Reference/Menus/_Include/_ShowButtons.rst.txt b/Documentation/Reference/ReStructuredText/Menus/_Include/_ShowButtons.rst.txt similarity index 100% rename from Documentation/WritingReST/Reference/Menus/_Include/_ShowButtons.rst.txt rename to Documentation/Reference/ReStructuredText/Menus/_Include/_ShowButtons.rst.txt diff --git a/Documentation/GeneralConventions/_guides-simple.xml b/Documentation/Reference/_guides-simple.xml similarity index 100% rename from Documentation/GeneralConventions/_guides-simple.xml rename to Documentation/Reference/_guides-simple.xml diff --git a/Documentation/RenderingDocs/Index.rst b/Documentation/RenderingDocs/Index.rst index 93596211..f6aaf624 100644 --- a/Documentation/RenderingDocs/Index.rst +++ b/Documentation/RenderingDocs/Index.rst @@ -42,31 +42,7 @@ Make sure that `Docker `__ 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 index ba3e84d0..5b48b9da 100644 --- 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 new file mode 100644 index 00000000..3a9340e3 --- /dev/null +++ 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"