diff --git a/Documentation/HowToAddTranslation/Index.rst b/Documentation/Advanced/HowToAddTranslation/Index.rst similarity index 100% rename from Documentation/HowToAddTranslation/Index.rst rename to Documentation/Advanced/HowToAddTranslation/Index.rst diff --git a/Documentation/GeneralConventions/ReviewInformation.rst b/Documentation/Advanced/ReviewInformation.rst similarity index 100% rename from Documentation/GeneralConventions/ReviewInformation.rst rename to Documentation/Advanced/ReviewInformation.rst diff --git a/Documentation/About.rst b/Documentation/Basics/About.rst similarity index 100% rename from Documentation/About.rst rename to Documentation/Basics/About.rst diff --git a/Documentation/BasicPrinciples.rst b/Documentation/Basics/BasicPrinciples.rst similarity index 100% rename from Documentation/BasicPrinciples.rst rename to Documentation/Basics/BasicPrinciples.rst diff --git a/Documentation/GeneralConventions/CodingGuidelines.rst b/Documentation/Basics/GeneralConventions/CodingGuidelines.rst similarity index 99% rename from Documentation/GeneralConventions/CodingGuidelines.rst rename to Documentation/Basics/GeneralConventions/CodingGuidelines.rst index bd3c7c2f..9277f7c6 100644 --- a/Documentation/GeneralConventions/CodingGuidelines.rst +++ b/Documentation/Basics/GeneralConventions/CodingGuidelines.rst @@ -50,7 +50,7 @@ Example: .. code-block:: rst :linenos: - .. image:: /Images/a4.jpg + .. image:: /_Images/a4.jpg :alt: Left floating image :target: https://typo3.org :class: with-shadow diff --git a/Documentation/GeneralConventions/ContentStyleGuide.rst b/Documentation/Basics/GeneralConventions/ContentStyleGuide.rst similarity index 100% rename from Documentation/GeneralConventions/ContentStyleGuide.rst rename to Documentation/Basics/GeneralConventions/ContentStyleGuide.rst diff --git a/Documentation/GeneralConventions/Format.rst b/Documentation/Basics/GeneralConventions/Format.rst similarity index 100% rename from Documentation/GeneralConventions/Format.rst rename to Documentation/Basics/GeneralConventions/Format.rst diff --git a/Documentation/GeneralConventions/Glossary.rst b/Documentation/Basics/GeneralConventions/Glossary.rst similarity index 100% rename from Documentation/GeneralConventions/Glossary.rst rename to Documentation/Basics/GeneralConventions/Glossary.rst diff --git a/Documentation/GeneralConventions/GuidelinesForImages.rst b/Documentation/Basics/GeneralConventions/GuidelinesForImages.rst similarity index 97% rename from Documentation/GeneralConventions/GuidelinesForImages.rst rename to Documentation/Basics/GeneralConventions/GuidelinesForImages.rst index ec8e907e..7bf4b4d7 100644 --- a/Documentation/GeneralConventions/GuidelinesForImages.rst +++ b/Documentation/Basics/GeneralConventions/GuidelinesForImages.rst @@ -124,13 +124,13 @@ To get the icons ---------------- Either download the zipfile and extract it. -You can find the download link on https://github.com/TYPO3-Documentation/Images, +You can find the download link on https://github.com/TYPO3-Documentation/_Images, Or clone the repository: .. code-block:: bash - git clone https://github.com/TYPO3-Documentation/Images + git clone https://github.com/TYPO3-Documentation/_Images The icons will be in images/final/icons. @@ -168,7 +168,7 @@ Examples SVG image with rectangles and numbers -.. figure:: /Images/edit_me_on_github+shadow.svg +.. figure:: /_Images/edit_me_on_github+shadow.svg :class: with-shadow :alt: Image with arrow diff --git a/Documentation/GeneralConventions/Index.rst b/Documentation/Basics/GeneralConventions/Index.rst similarity index 100% rename from Documentation/GeneralConventions/Index.rst rename to Documentation/Basics/GeneralConventions/Index.rst diff --git a/Documentation/GeneralConventions/Licenses.rst b/Documentation/Basics/GeneralConventions/Licenses.rst similarity index 100% rename from Documentation/GeneralConventions/Licenses.rst rename to Documentation/Basics/GeneralConventions/Licenses.rst diff --git a/Documentation/GeneralConventions/ReadmeFile.rst b/Documentation/Basics/GeneralConventions/ReadmeFile.rst similarity index 83% rename from Documentation/GeneralConventions/ReadmeFile.rst rename to Documentation/Basics/GeneralConventions/ReadmeFile.rst index 3a5061e9..46b6029c 100644 --- a/Documentation/GeneralConventions/ReadmeFile.rst +++ b/Documentation/Basics/GeneralConventions/ReadmeFile.rst @@ -18,23 +18,23 @@ example: .. group-tab:: With placeholders - .. include:: /CodeSnippets/FileStructure/ReadmeRst.rst.txt + .. include:: /_CodeSnippets/FileStructure/ReadmeRst.rst.txt .. group-tab:: Third-party extension - .. include:: /CodeSnippets/FileStructure/Examples/IndexRst.rst.txt + .. include:: /_CodeSnippets/FileStructure/Examples/IndexRst.rst.txt .. group-tab:: System extension - .. include:: /CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt + .. include:: /_CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt .. group-tab:: Official manual - .. include:: /CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt + .. include:: /_CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt .. group-tab:: Markdown - .. include:: /CodeSnippets/FileStructure/ReadmeMd.rst.txt + .. include:: /_CodeSnippets/FileStructure/ReadmeMd.rst.txt .. _readme-rst-badges: @@ -50,11 +50,11 @@ monthly download rate and the supported TYPO3 versions: .. group-tab:: reStructured Text - .. include:: /CodeSnippets/FileStructure/Badges.rst.txt + .. include:: /_CodeSnippets/FileStructure/Badges.rst.txt .. group-tab:: Markdown - .. include:: /CodeSnippets/FileStructure/BadgesMd.rst.txt + .. include:: /_CodeSnippets/FileStructure/BadgesMd.rst.txt Remove this field if the project is no extension or package. diff --git a/Documentation/GeneralConventions/ReviewPolicy.rst b/Documentation/Basics/GeneralConventions/ReviewPolicy.rst similarity index 100% rename from Documentation/GeneralConventions/ReviewPolicy.rst rename to Documentation/Basics/GeneralConventions/ReviewPolicy.rst diff --git a/Documentation/GeneralConventions/images/backend-raw.png b/Documentation/Basics/GeneralConventions/images/backend-raw.png similarity index 100% rename from Documentation/GeneralConventions/images/backend-raw.png rename to Documentation/Basics/GeneralConventions/images/backend-raw.png diff --git a/Documentation/GeneralConventions/images/backend-with-boxes-2.svg b/Documentation/Basics/GeneralConventions/images/backend-with-boxes-2.svg similarity index 100% rename from Documentation/GeneralConventions/images/backend-with-boxes-2.svg rename to Documentation/Basics/GeneralConventions/images/backend-with-boxes-2.svg diff --git a/Documentation/GeneralConventions/images/backend-with-boxes.png b/Documentation/Basics/GeneralConventions/images/backend-with-boxes.png similarity index 100% rename from Documentation/GeneralConventions/images/backend-with-boxes.png rename to Documentation/Basics/GeneralConventions/images/backend-with-boxes.png diff --git a/Documentation/GeneralConventions/images/github-getting-started-raw.png b/Documentation/Basics/GeneralConventions/images/github-getting-started-raw.png similarity index 100% rename from Documentation/GeneralConventions/images/github-getting-started-raw.png rename to Documentation/Basics/GeneralConventions/images/github-getting-started-raw.png diff --git a/Documentation/HowToGetHelp.rst b/Documentation/Basics/HowToGetHelp.rst similarity index 100% rename from Documentation/HowToGetHelp.rst rename to Documentation/Basics/HowToGetHelp.rst diff --git a/Documentation/WritingDocsOfficial/HowYouCanHelp.rst b/Documentation/Howto/Contribute/HowYouCanHelp.rst similarity index 99% rename from Documentation/WritingDocsOfficial/HowYouCanHelp.rst rename to Documentation/Howto/Contribute/HowYouCanHelp.rst index 377e70ca..c34d999d 100644 --- a/Documentation/WritingDocsOfficial/HowYouCanHelp.rst +++ b/Documentation/Howto/Contribute/HowYouCanHelp.rst @@ -1,3 +1,5 @@ +:navigation-title: Help + .. include:: /Includes.rst.txt .. _docs-official-how-you-can-help: @@ -130,7 +132,7 @@ Here are some examples: * :ref:`Check out sequence diagram on new page about request handling ` - .. figure:: /Images/diagram.png + .. figure:: /_Images/diagram.png :alt: Example of a sequence diagram about request handling :class: with-shadow diff --git a/Documentation/WritingDocsOfficial/Index.rst b/Documentation/Howto/Contribute/Index.rst similarity index 96% rename from Documentation/WritingDocsOfficial/Index.rst rename to Documentation/Howto/Contribute/Index.rst index 9a289eef..d0dce3c9 100644 --- a/Documentation/WritingDocsOfficial/Index.rst +++ b/Documentation/Howto/Contribute/Index.rst @@ -1,3 +1,5 @@ +:navigation-title: Contribute + .. include:: /Includes.rst.txt .. index:: Official documentation .. _contribute: @@ -50,9 +52,8 @@ There are two different ways in which you can make your changes before submittin :ref:`docs-contribute-git-docker` -.. toctree:: - :hidden: +.. toctree:: + :hidden: + :glob: - GithubMethod - LocalEditing - HowYouCanHelp + * diff --git a/Documentation/WritingDocsOfficial/LocalEditing.rst b/Documentation/Howto/EditLocal.rst similarity index 98% rename from Documentation/WritingDocsOfficial/LocalEditing.rst rename to Documentation/Howto/EditLocal.rst index 7b03de80..8fd3a50e 100644 --- a/Documentation/WritingDocsOfficial/LocalEditing.rst +++ b/Documentation/Howto/EditLocal.rst @@ -1,3 +1,5 @@ +:navigation-title: Edit Locally + .. include:: /Includes.rst.txt .. index:: Official documentation; Local editing .. _docs-contribute-git-docker: @@ -28,7 +30,7 @@ the ability to experiment and preview your changes locally before submitting the From here, select the "Fork" button in the upper right corner of the page. - .. image:: /Images/github-fork.png + .. image:: /_Images/github-fork.png :class: with-shadow 3. Clone the forked repository diff --git a/Documentation/WritingDocsOfficial/GithubMethod.rst b/Documentation/Howto/EditOnGithub.rst similarity index 89% rename from Documentation/WritingDocsOfficial/GithubMethod.rst rename to Documentation/Howto/EditOnGithub.rst index 93c4525e..6904ed8d 100644 --- a/Documentation/WritingDocsOfficial/GithubMethod.rst +++ b/Documentation/Howto/EditOnGithub.rst @@ -1,3 +1,5 @@ +:navigation-title: Edit on GitHub + .. include:: /Includes.rst.txt .. index:: pair: Official documentation; "Edit on GitHub" .. _docs-contribute-github-method: @@ -28,7 +30,7 @@ Workflow #1: "Edit on GitHub" At the top right of every page you will find an icon that says "Edit me on Github". Selecting this link will take you to that pages repository on GitHub. - .. image:: /Images/edit_me_on_github.png + .. image:: /_Images/edit_me_on_github.png :class: with-border with-shadow 4. Fork the repository: @@ -36,7 +38,7 @@ Workflow #1: "Edit on GitHub" Click on the green button to fork the repository. This will clone the repository into your GitHub account, ready for you to make your changes in your browser. - .. image:: /Images/github-edit-fork.png + .. image:: /_Images/github-edit-fork.png :class: with-border with-shadow 5. Make your changes: @@ -45,7 +47,7 @@ Workflow #1: "Edit on GitHub" The *"Indent mode: Spaces"* and *"Indent size: 4"* values should already be set - do not alter these. - .. image:: /Images/github-edit-window.png + .. image:: /_Images/github-edit-window.png :class: with-border with-shadow @@ -61,7 +63,7 @@ Workflow #1: "Edit on GitHub" You can go back and make further changes at any time, select the Edit file tab to continue editing. - .. image:: /Images/github-edit-preview.png + .. image:: /_Images/github-edit-preview.png :class: with-border with-shadow 8. Finalize your changes: @@ -70,7 +72,7 @@ Workflow #1: "Edit on GitHub" a short (but meaningful) description that outlines the changes you have made and click "Propose file change" - .. image:: /Images/github-propose-file-changes.png + .. image:: /_Images/github-propose-file-changes.png :class: with-border with-shadow 9. Create pull request: @@ -78,12 +80,12 @@ Workflow #1: "Edit on GitHub" GitHub will show you an overview of your changes. If you are happy with them, select "Create pull request". - .. image:: /Images/github-comparing-changes.png + .. image:: /_Images/github-comparing-changes.png :class: with-border with-shadow Finally, create your pull request: - .. image:: /Images/github-create-pull-request2.png + .. image:: /_Images/github-create-pull-request2.png :class: with-border with-shadow 10. You're done! @@ -108,13 +110,13 @@ See `June 2018: Developer Appreciation Day for an example. -.. image:: /Images/dad-with-image.png +.. image:: /_Images/dad-with-image.png :target: https://typo3.com/blog/june-2018-developer-appreciation-day-dad/?utm_medium=TYPO3%2BBlog&utm_source=Blog%2BPost%2B-%2BJune%2B2018%3A%2BDeveloper%2BAppreciation%2BDay%2B%28DAD%29 :class: with-border with-shadow Scroll down to "Improving documentation": -.. image:: /Images/dad-improve-docs.png +.. image:: /_Images/dad-improve-docs.png :target: https://typo3.com/blog/june-2018-developer-appreciation-day-dad/?utm_medium=TYPO3%2BBlog&utm_source=Blog%2BPost%2B-%2BJune%2B2018%3A%2BDeveloper%2BAppreciation%2BDay%2B%28DAD%29 :class: with-border with-shadow diff --git a/Documentation/Migration/Index.rst b/Documentation/Howto/Migration/Index.rst similarity index 98% rename from Documentation/Migration/Index.rst rename to Documentation/Howto/Migration/Index.rst index d1b2260b..907babac 100644 --- a/Documentation/Migration/Index.rst +++ b/Documentation/Howto/Migration/Index.rst @@ -1,3 +1,5 @@ +:navigation-title: Migrate + .. include:: /Includes.rst.txt .. index:: Documentation; Migration @@ -323,7 +325,7 @@ The link is leading to We have to click the symbol next to the heading and copy the correct link which is the one for restructured text -.. image:: /Images/get_link.png +.. image:: /_Images/get_link.png :class: with-shadow :width: 600px @@ -348,7 +350,7 @@ https://github.com/TYPO3-Documentation/render-guides/blob/main/Makefile A small example :file:`Makefile`: -.. literalinclude:: /CodeSnippets/_Makefile +.. literalinclude:: /_CodeSnippets/_Makefile :language: plaintext :caption: Makefile @@ -376,7 +378,7 @@ ensure the extension's documentation renders without warnings. An example workflow on GitHub would be established via this file in :file:`.github/workflows/documentation.yml`: -.. literalinclude:: /CodeSnippets/_documentation.yml +.. literalinclude:: /_CodeSnippets/_documentation.yml :caption: .github/workflows/documentation.yml diff --git a/Documentation/RenderingDocs/Index.rst b/Documentation/Howto/RenderingDocs/Index.rst similarity index 99% rename from Documentation/RenderingDocs/Index.rst rename to Documentation/Howto/RenderingDocs/Index.rst index f6aaf624..7f36dda2 100644 --- a/Documentation/RenderingDocs/Index.rst +++ b/Documentation/Howto/RenderingDocs/Index.rst @@ -1,3 +1,5 @@ +:navigation-title: Render + .. include:: /Includes.rst.txt .. Index:: pair: Documentation; Rendering diff --git a/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst b/Documentation/Howto/WritingDocForExtension/ContributeToSystemExtension.rst similarity index 98% rename from Documentation/WritingDocForExtension/ContributeToSystemExtension.rst rename to Documentation/Howto/WritingDocForExtension/ContributeToSystemExtension.rst index cd93790e..8af1c4d5 100644 --- a/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst +++ b/Documentation/Howto/WritingDocForExtension/ContributeToSystemExtension.rst @@ -33,7 +33,7 @@ see :ref:`overview-of-types`. comment in your pull request with information about where to find your patch on Gerrit. - .. image:: /Images/github-gerrit.png + .. image:: /_Images/github-gerrit.png :class: with-shadow :target: https://github.com/typo3/typo3/pull/172#issuecomment-494721296 diff --git a/Documentation/WritingDocForExtension/ContributeToThirdPartyExtension.rst b/Documentation/Howto/WritingDocForExtension/ContributeToThirdPartyExtension.rst similarity index 96% rename from Documentation/WritingDocForExtension/ContributeToThirdPartyExtension.rst rename to Documentation/Howto/WritingDocForExtension/ContributeToThirdPartyExtension.rst index b24100f8..178f3056 100644 --- a/Documentation/WritingDocForExtension/ContributeToThirdPartyExtension.rst +++ b/Documentation/Howto/WritingDocForExtension/ContributeToThirdPartyExtension.rst @@ -59,7 +59,7 @@ Method 2: Find the Source on https://extensions.typo3.org 3. Select the extension - .. image:: /Images/ter_news2.png + .. image:: /_Images/ter_news2.png :alt: Link: Show manual :target: https://extensions.typo3.org/?L=0&id=1&tx_solr%5Bq%5D=news :class: with-shadow @@ -67,7 +67,7 @@ Method 2: Find the Source on https://extensions.typo3.org 4. Click take a look in the code - .. image:: /Images/take-a-look-in-the-code.png + .. image:: /_Images/take-a-look-in-the-code.png :alt: Link: Take a look in the code :target: https://github.com/georgringer/news :class: with-shadow @@ -101,7 +101,7 @@ Method 2: Find rendered manual on https://extensions.typo3.org 3. Click on "Show Manual" - .. image:: /Images/ter_news.png + .. image:: /_Images/ter_news.png :alt: Link: Show manual :target: https://docs.typo3.org/typo3cms/extensions/news/ :class: with-shadow diff --git a/Documentation/WritingDocForExtension/FAQ.rst b/Documentation/Howto/WritingDocForExtension/FAQ.rst similarity index 98% rename from Documentation/WritingDocForExtension/FAQ.rst rename to Documentation/Howto/WritingDocForExtension/FAQ.rst index 84815d56..90da5201 100644 --- a/Documentation/WritingDocForExtension/FAQ.rst +++ b/Documentation/Howto/WritingDocForExtension/FAQ.rst @@ -31,7 +31,7 @@ If you are missing documentation for some extension versions we have a Why Does the Documentation not provide a title? =============================================== -.. image:: /Images/missing-title.png +.. image:: /_Images/missing-title.png :class: with-shadow Refer to :ref:`migrate` in order to fix this issue. @@ -175,7 +175,7 @@ How do I get an "Edit on GitHub" button? Why might you want an "Edit on GitHub" button on the rendered pages of your extension documentation? -.. figure:: /Images/edit_me_on_github+shadow.svg +.. figure:: /_Images/edit_me_on_github+shadow.svg :class: with-shadow :alt: "Edit on GitHub" button diff --git a/Documentation/WritingDocForExtension/Index.rst b/Documentation/Howto/WritingDocForExtension/Index.rst similarity index 99% rename from Documentation/WritingDocForExtension/Index.rst rename to Documentation/Howto/WritingDocForExtension/Index.rst index f202f4f6..a091147a 100644 --- a/Documentation/WritingDocForExtension/Index.rst +++ b/Documentation/Howto/WritingDocForExtension/Index.rst @@ -1,3 +1,5 @@ +:navigation-title: Document extensions + .. include:: /Includes.rst.txt .. index:: Documentation; Extension .. _writing-doc-for-ext-start: diff --git a/Documentation/WritingDocForExtension/ReregisterVersions.rst b/Documentation/Howto/WritingDocForExtension/ReregisterVersions.rst similarity index 100% rename from Documentation/WritingDocForExtension/ReregisterVersions.rst rename to Documentation/Howto/WritingDocForExtension/ReregisterVersions.rst diff --git a/Documentation/WritingDocForExtension/Webhook.rst b/Documentation/Howto/WritingDocForExtension/Webhook.rst similarity index 85% rename from Documentation/WritingDocForExtension/Webhook.rst rename to Documentation/Howto/WritingDocForExtension/Webhook.rst index 20a5e572..88ea0205 100644 --- a/Documentation/WritingDocForExtension/Webhook.rst +++ b/Documentation/Howto/WritingDocForExtension/Webhook.rst @@ -93,17 +93,17 @@ Add auto rendering for a repository via GitHub webhook in five steps: #. Go to "Settings" tab within the repository - .. figure:: /Images/webhook/github/repository-start.png + .. figure:: /_Images/webhook/github/repository-start.png :width: 932 #. Go to "Webhooks" section within the repository settings - .. figure:: /Images/webhook/github/settings-tab.png + .. figure:: /_Images/webhook/github/settings-tab.png :width: 932 #. Add webhook - .. figure:: /Images/webhook/github/webhook-section.png + .. figure:: /_Images/webhook/github/webhook-section.png :width: 932 #. Fill in webhook configuration @@ -120,14 +120,14 @@ Add auto rendering for a repository via GitHub webhook in five steps: #. Click on "Add webhook" - .. figure:: /Images/webhook/github/webhook-add.png + .. figure:: /_Images/webhook/github/webhook-add.png :width: 932 #. Webhook was added GitHub should show a notice that creation of webhook was successful. - .. figure:: /Images/webhook/github/webhook-added.png + .. figure:: /_Images/webhook/github/webhook-added.png :width: 932 #. Trigger webhook and visit to check request @@ -139,7 +139,7 @@ Add auto rendering for a repository via GitHub webhook in five steps: For the documentation to be rendered, the hook needs to be triggered: Either push to the branch ``main``. Or push to a new branch ``documentation-draft``. - .. figure:: /Images/webhook/github/intercept-feedback.png + .. figure:: /_Images/webhook/github/intercept-feedback.png :width: 932 @@ -155,17 +155,17 @@ Add auto rendering for a repository via Bitbucket webhook in five steps: #. Go to "Settings" section within the repository - .. figure:: /Images/webhook/bitbucket/cloud/repository-start.png + .. figure:: /_Images/webhook/bitbucket/cloud/repository-start.png :width: 932 #. Go to "Webhooks" section within the repository settings - .. figure:: /Images/webhook/bitbucket/cloud/settings-tab.png + .. figure:: /_Images/webhook/bitbucket/cloud/settings-tab.png :width: 932 #. Add webhook - .. figure:: /Images/webhook/bitbucket/cloud/webhook-section.png + .. figure:: /_Images/webhook/bitbucket/cloud/webhook-section.png :width: 932 #. Fill in webhook configuration @@ -180,7 +180,7 @@ Add auto rendering for a repository via Bitbucket webhook in five steps: #. Click on "Save" - .. figure:: /Images/webhook/bitbucket/cloud/webhook-add.png + .. figure:: /_Images/webhook/bitbucket/cloud/webhook-add.png :width: 932 #. Webhook was added @@ -189,7 +189,7 @@ Add auto rendering for a repository via Bitbucket webhook in five steps: creation of webhook was successful. Also the webhook should be shown in the list. - .. figure:: /Images/webhook/bitbucket/cloud/webhook-added.png + .. figure:: /_Images/webhook/bitbucket/cloud/webhook-added.png :width: 932 #. Trigger webhook and visit to check request @@ -200,7 +200,7 @@ Add auto rendering for a repository via Bitbucket webhook in five steps: For the documentation to be rendered, the hook needs to be triggered: Either push to the branch ``main``. Or push to a new branch ``documentation-draft``. - .. figure:: /Images/webhook/bitbucket/cloud/intercept-feedback.png + .. figure:: /_Images/webhook/bitbucket/cloud/intercept-feedback.png :width: 932 .. index:: @@ -217,7 +217,7 @@ Add auto rendering for a repository via GitLab webhook in four steps: #. Go to "Integrations" section within the repository - .. figure:: /Images/webhook/gitlab/repository-start.png + .. figure:: /_Images/webhook/gitlab/repository-start.png :width: 932 #. Add webhook by filling in webhook configuration @@ -228,14 +228,14 @@ Add auto rendering for a repository via GitLab webhook in four steps: #. Click on "Add webhook" - .. figure:: /Images/webhook/gitlab/webhook-add.png + .. figure:: /_Images/webhook/gitlab/webhook-add.png :width: 932 #. Webhook was added The webhook should be shown in the list (scroll down). - .. figure:: /Images/webhook/gitlab/webhook-added.png + .. figure:: /_Images/webhook/gitlab/webhook-added.png :width: 932 #. Trigger webhook and visit to check request @@ -246,5 +246,5 @@ Add auto rendering for a repository via GitLab webhook in four steps: For the documentation to be rendered, the hook needs to be triggered: Either push to the branch ``main``. Or push to a new branch ``documentation-draft``. - .. figure:: /Images/webhook/gitlab/intercept-feedback.png + .. figure:: /_Images/webhook/gitlab/intercept-feedback.png :width: 932 diff --git a/Documentation/WritingReST/BasicRestSyntax.rst b/Documentation/Howto/WritingReST/BasicRestSyntax.rst similarity index 100% rename from Documentation/WritingReST/BasicRestSyntax.rst rename to Documentation/Howto/WritingReST/BasicRestSyntax.rst diff --git a/Documentation/WritingReST/CheatSheet.rst b/Documentation/Howto/WritingReST/CheatSheet.rst similarity index 99% rename from Documentation/WritingReST/CheatSheet.rst rename to Documentation/Howto/WritingReST/CheatSheet.rst index 9feb6a6f..f12494f5 100644 --- a/Documentation/WritingReST/CheatSheet.rst +++ b/Documentation/Howto/WritingReST/CheatSheet.rst @@ -395,21 +395,21 @@ Source: **How it looks:** -.. image:: /Images/a4.jpg +.. image:: /_Images/a4.jpg :class: with-shadow Source: .. code-block:: rst - .. image:: /Images/a4.jpg + .. image:: /_Images/a4.jpg :class: with-shadow Another example: .. code-block:: rst - .. image:: /Images/a4.jpg + .. image:: /_Images/a4.jpg :class: with-shadow :target: https://typo3.org :alt: alt text @@ -462,7 +462,7 @@ This is an example with a code block (:rst:`::`) embedded in the sections. .. code-block:: rst - /Images/a4.jpg + /_Images/a4.jpg :class: with-shadow 2. Two @@ -502,7 +502,7 @@ With Big Numbers XXL .. code-block:: rst - /Images/a4.jpg + /_Images/a4.jpg :class: with-shadow 2. Two diff --git a/Documentation/WritingReST/Index.rst b/Documentation/Howto/WritingReST/Index.rst similarity index 97% rename from Documentation/WritingReST/Index.rst rename to Documentation/Howto/WritingReST/Index.rst index 5b48b9da..cad68f63 100644 --- a/Documentation/WritingReST/Index.rst +++ b/Documentation/Howto/WritingReST/Index.rst @@ -1,3 +1,5 @@ +:navigation-title: Write ReST + .. include:: /Includes.rst.txt .. index:: reStructuredText diff --git a/Documentation/WritingReST/Introduction.rst b/Documentation/Howto/WritingReST/Introduction.rst similarity index 97% rename from Documentation/WritingReST/Introduction.rst rename to Documentation/Howto/WritingReST/Introduction.rst index a8e8434d..ae6505a0 100644 --- a/Documentation/WritingReST/Introduction.rst +++ b/Documentation/Howto/WritingReST/Introduction.rst @@ -92,7 +92,7 @@ source files change, they are rerendered. Our headline example from above will look like this: -.. image:: /Images/rendered-headers.png +.. image:: /_Images/rendered-headers.png :class: with-shadow @@ -105,7 +105,7 @@ at the source code by clicking on the :guilabel:`View source` at the top of a pa That way, you can see how it is done and compare the reST source with the rendered version. -.. image:: /Images/view-page-source.png +.. image:: /_Images/view-page-source.png :class: with-shadow diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 3a6e9d73..86fb12b3 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -90,11 +90,10 @@ reStructuredText (reST). :hidden: :caption: BASICS - About - HowToGetHelp - BasicPrinciples - GeneralConventions/Index - WritingReST/Index + Basics/About + Basics/HowToGetHelp + Basics/BasicPrinciples + Basics/GeneralConventions/Index .. toctree:: @@ -109,17 +108,15 @@ reStructuredText (reST). :hidden: :caption: HOWTOS - Migration/Index - WritingDocForExtension/Index - WritingDocsOfficial/Index - RenderingDocs/Index + Howto/* + Howto/*/Index .. toctree:: :hidden: :caption: ADVANCED - HowToAddTranslation/Index - GeneralConventions/ReviewInformation + Advanced/HowToAddTranslation/Index + Advanced/ReviewInformation .. toctree:: :hidden: diff --git a/Documentation/Reference/FileStructure.rst b/Documentation/Reference/FileStructure.rst index d9f823b4..3149eb02 100644 --- a/Documentation/Reference/FileStructure.rst +++ b/Documentation/Reference/FileStructure.rst @@ -242,8 +242,8 @@ to the next steps, for example .. group-tab:: Rest - .. include:: /CodeSnippets/FileStructure/ReadmeRstStandalone.rst.txt + .. include:: /_CodeSnippets/FileStructure/ReadmeRstStandalone.rst.txt .. group-tab:: Markdown - .. include:: /CodeSnippets/FileStructure/ReadmeMdStandalone.rst.txt + .. include:: /_CodeSnippets/FileStructure/ReadmeMdStandalone.rst.txt diff --git a/Documentation/Reference/GuidesXml.rst b/Documentation/Reference/GuidesXml.rst index 46154b1a..29b81b26 100644 --- a/Documentation/Reference/GuidesXml.rst +++ b/Documentation/Reference/GuidesXml.rst @@ -363,7 +363,7 @@ of a manual. * A shortcode supported by the theme: :ref:`Available default inventories ` - .. figure:: /Images/ReferenceThisHeadlineDialog.png + .. figure:: /_Images/ReferenceThisHeadlineDialog.png :alt: Reference a headline dialog showing the shortcode georgringer/news Reference a headline in the EXT:news manual diff --git a/Documentation/Reference/ReStructuredText/Code/Codeblocks.rst b/Documentation/Reference/ReStructuredText/Code/Codeblocks.rst index be870870..c00cd6bb 100644 --- a/Documentation/Reference/ReStructuredText/Code/Codeblocks.rst +++ b/Documentation/Reference/ReStructuredText/Code/Codeblocks.rst @@ -369,14 +369,14 @@ code block. .. code-block:: rst :caption: Documentation/SiteConfiguration/Index.rst - .. literalinclude:: /CodeSnippets/LiteralIncludes/example.yaml + .. literalinclude:: /_CodeSnippets/LiteralIncludes/example.yaml :language: yaml :emphasize-lines: 5,10-13 :linenos: .. group-tab:: Output - .. literalinclude:: /CodeSnippets/LiteralIncludes/example.yaml + .. literalinclude:: /_CodeSnippets/LiteralIncludes/example.yaml :language: yaml :emphasize-lines: 5,10-13 :linenos: @@ -391,13 +391,13 @@ without having to create a diff file first: .. code-block:: rst :caption: Documentation/SiteConfiguration/Index.rst - .. literalinclude:: /CodeSnippets/LiteralIncludes/example.yaml - :diff: /CodeSnippets/LiteralIncludes/example_de.yaml + .. literalinclude:: /_CodeSnippets/LiteralIncludes/example.yaml + :diff: /_CodeSnippets/LiteralIncludes/example_de.yaml .. group-tab:: Output - .. literalinclude:: /CodeSnippets/LiteralIncludes/example.yaml - :diff: /CodeSnippets/LiteralIncludes/example_de.yaml + .. literalinclude:: /_CodeSnippets/LiteralIncludes/example.yaml + :diff: /_CodeSnippets/LiteralIncludes/example_de.yaml See also `literalinclude directive diff --git a/Documentation/Reference/ReStructuredText/Content/Accordion.rst b/Documentation/Reference/ReStructuredText/Content/Accordion.rst index 5e0dbdd5..1bd21096 100644 --- a/Documentation/Reference/ReStructuredText/Content/Accordion.rst +++ b/Documentation/Reference/ReStructuredText/Content/Accordion.rst @@ -162,7 +162,7 @@ Accordion with complex content :name: headingThree3 :header-level: 3 - .. image:: /Images/q150_ffffff.png + .. image:: /_Images/q150_ffffff.png :alt: Image with background color #ffffff :class: with-border with-shadow @@ -203,6 +203,6 @@ Accordion with complex content :name: headingThree3 :header-level: 3 - .. image:: /Images/q150_ffffff.png + .. image:: /_Images/q150_ffffff.png :alt: Image with background color #ffffff :class: with-border with-shadow diff --git a/Documentation/Reference/ReStructuredText/Content/Cards.rst b/Documentation/Reference/ReStructuredText/Content/Cards.rst index 6f1dc97d..beac661c 100644 --- a/Documentation/Reference/ReStructuredText/Content/Cards.rst +++ b/Documentation/Reference/ReStructuredText/Content/Cards.rst @@ -176,7 +176,7 @@ Cards with images .. card:: :ref:`Cards ` - .. card-image:: /Images/cards.png + .. card-image:: /_Images/cards.png :alt: Cards, example output Cards can be used to shortly introduce topics and generate @@ -184,14 +184,14 @@ Cards with images .. card:: :ref:`Tabs ` - .. card-image:: /Images/tabs.png + .. card-image:: /_Images/tabs.png :alt: Tabs, example output Tabs can be used to present a topic from different perspectives. .. card:: :ref:`Cards ` - .. card-image:: /Images/cards.png + .. card-image:: /_Images/cards.png :alt: Cards, example output Cards can be used to shortly introduce topics and generate @@ -200,7 +200,7 @@ Cards with images .. card:: :ref:`Tabs ` - .. card-image:: /Images/tabs.png + .. card-image:: /_Images/tabs.png :alt: Tabs, example output :position: bottom @@ -219,7 +219,7 @@ Cards with images .. card:: :ref:`Cards ` - .. card-image:: /Images/cards.png + .. card-image:: /_Images/cards.png :alt: Cards, example output Cards can be used to shortly introduce topics and generate @@ -227,14 +227,14 @@ Cards with images .. card:: :ref:`Tabs ` - .. card-image:: /Images/tabs.png + .. card-image:: /_Images/tabs.png :alt: Tabs, example output Tabs can be used to present a topic from different perspectives. .. card:: :ref:`Cards ` - .. card-image:: /Images/cards.png + .. card-image:: /_Images/cards.png :alt: Cards, example output Cards can be used to shortly introduce topics and generate @@ -243,7 +243,7 @@ Cards with images .. card:: :ref:`Tabs ` - .. card-image:: /Images/tabs.png + .. card-image:: /_Images/tabs.png :alt: Tabs, example output :position: bottom diff --git a/Documentation/Reference/ReStructuredText/Content/Links.rst b/Documentation/Reference/ReStructuredText/Content/Links.rst index f9983f0d..c217742d 100644 --- a/Documentation/Reference/ReStructuredText/Content/Links.rst +++ b/Documentation/Reference/ReStructuredText/Content/Links.rst @@ -28,14 +28,14 @@ It is also possible to put an anchor almost anywhere and then link it. When an element in a manual can be linked a link symbol will appear when you hover it: -.. figure:: /Images/link-headlines.png +.. figure:: /_Images/link-headlines.png Hover over a headline to see if it is linkable, then click the link icon After you click the link icon you can copy the reST link from the modal that appears: -.. figure:: /Images/link-headlines-box.png +.. figure:: /_Images/link-headlines-box.png Copy the reST reference @@ -64,7 +64,7 @@ including the colon. If there is a warning box displayed, that the link has no anchor, you can still link to it using a doc-reference: -.. figure:: /Images/link-headlines-box-warning.png +.. figure:: /_Images/link-headlines-box-warning.png Linking to a headline without an anchor @@ -163,7 +163,7 @@ system extensions like :t3ext:`adminpanel`: Linking source files of the TYPO3 Core ====================================== -Any file within the TYPO3 Core can be linked to their source file on GitHub using +Any file within the TYPO3 Core can be linked to their source file on GitHub using the text role :rst:`t3src`. You can link classes like the diff --git a/Documentation/Reference/ReStructuredText/Graphics/Images.rst b/Documentation/Reference/ReStructuredText/Graphics/Images.rst index aad3c960..645fe639 100644 --- a/Documentation/Reference/ReStructuredText/Graphics/Images.rst +++ b/Documentation/Reference/ReStructuredText/Graphics/Images.rst @@ -57,7 +57,7 @@ Examples Example 1: Scaled image with shadow and link target --------------------------------------------------- -.. image:: /Images/a4.jpg +.. image:: /_Images/a4.jpg :alt: Left floating image :target: https://typo3.org :class: with-shadow @@ -66,7 +66,7 @@ Example 1: Scaled image with shadow and link target .. code-block:: rst :linenos: - .. image:: /Images/a4.jpg + .. image:: /_Images/a4.jpg :alt: some image :target: https://typo3.org :class: with-shadow @@ -93,7 +93,7 @@ Example 1: Scaled image with shadow and link target Example 2: Image with caption ----------------------------- -.. figure:: /Images/a4.jpg +.. figure:: /_Images/a4.jpg :alt: Left floating image :target: https://typo3.org :class: with-shadow @@ -104,7 +104,7 @@ Example 2: Image with caption .. code-block:: rst :linenos: - .. figure:: /Images/a4.jpg + .. figure:: /_Images/a4.jpg :alt: some image :target: https://typo3.org :class: with-shadow @@ -119,7 +119,7 @@ Example 2: Image with caption Example 3: Image with fixed width --------------------------------- -.. image:: /Images/a4.jpg +.. image:: /_Images/a4.jpg :alt: Left floating image :target: https://typo3.org :class: with-shadow @@ -129,7 +129,7 @@ Example 3: Image with fixed width .. code-block:: rst :linenos: - .. image:: /Images/a4.jpg + .. image:: /_Images/a4.jpg :alt: some image :target: https://typo3.org :class: with-shadow @@ -145,7 +145,7 @@ Example 3: Image with fixed width Example 4: Image with float-left -------------------------------- -.. image:: /Images/a4.jpg +.. image:: /_Images/a4.jpg :alt: Left floating image :target: https://typo3.org :class: with-shadow float-left @@ -157,7 +157,7 @@ Some text ... (will be displayed on the right of the image). .. code-block:: rst - .. image:: /Images/a4.jpg + .. image:: /_Images/a4.jpg :alt: Left floating image :target: https://typo3.org :class: with-shadow float-left @@ -177,5 +177,5 @@ Some text ... (will be displayed on the right of the image). Example 5: Image with border ---------------------------- -.. image:: /Images/a4.jpg +.. image:: /_Images/a4.jpg :class: with-border diff --git a/Documentation/Reference/ReStructuredText/Menus/IncludingFiles.rst b/Documentation/Reference/ReStructuredText/Menus/IncludingFiles.rst index 66945ab4..dda7011b 100644 --- a/Documentation/Reference/ReStructuredText/Menus/IncludingFiles.rst +++ b/Documentation/Reference/ReStructuredText/Menus/IncludingFiles.rst @@ -109,7 +109,7 @@ example: The option `:show-buttons:` display a special "Edit on GitHub" button only for the section contained within include: -.. figure:: /Images/include-with-button.png +.. figure:: /_Images/include-with-button.png The edit on GitHub button of an included section diff --git a/Documentation/CodeSnippets/FileStructure/Badges.rst.txt b/Documentation/_CodeSnippets/FileStructure/Badges.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/Badges.rst.txt rename to Documentation/_CodeSnippets/FileStructure/Badges.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/BadgesMd.rst.txt b/Documentation/_CodeSnippets/FileStructure/BadgesMd.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/BadgesMd.rst.txt rename to Documentation/_CodeSnippets/FileStructure/BadgesMd.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt b/Documentation/_CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt rename to Documentation/_CodeSnippets/FileStructure/Dashboard/IndexRst.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/Dashboard/ReadmeRst.rst.txt b/Documentation/_CodeSnippets/FileStructure/Dashboard/ReadmeRst.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/Dashboard/ReadmeRst.rst.txt rename to Documentation/_CodeSnippets/FileStructure/Dashboard/ReadmeRst.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/Dashboard/SettingsCfg.rst.txt b/Documentation/_CodeSnippets/FileStructure/Dashboard/SettingsCfg.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/Dashboard/SettingsCfg.rst.txt rename to Documentation/_CodeSnippets/FileStructure/Dashboard/SettingsCfg.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/Examples/IndexRst.rst.txt b/Documentation/_CodeSnippets/FileStructure/Examples/IndexRst.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/Examples/IndexRst.rst.txt rename to Documentation/_CodeSnippets/FileStructure/Examples/IndexRst.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/Examples/ReadmeRst.rst.txt b/Documentation/_CodeSnippets/FileStructure/Examples/ReadmeRst.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/Examples/ReadmeRst.rst.txt rename to Documentation/_CodeSnippets/FileStructure/Examples/ReadmeRst.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/Examples/SettingsCfg.rst.txt b/Documentation/_CodeSnippets/FileStructure/Examples/SettingsCfg.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/Examples/SettingsCfg.rst.txt rename to Documentation/_CodeSnippets/FileStructure/Examples/SettingsCfg.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt b/Documentation/_CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt rename to Documentation/_CodeSnippets/FileStructure/GettingStarted/IndexRst.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/GettingStarted/ReadmeRst.rst.txt b/Documentation/_CodeSnippets/FileStructure/GettingStarted/ReadmeRst.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/GettingStarted/ReadmeRst.rst.txt rename to Documentation/_CodeSnippets/FileStructure/GettingStarted/ReadmeRst.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/GettingStarted/SettingsCfg.rst.txt b/Documentation/_CodeSnippets/FileStructure/GettingStarted/SettingsCfg.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/GettingStarted/SettingsCfg.rst.txt rename to Documentation/_CodeSnippets/FileStructure/GettingStarted/SettingsCfg.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/IndexRst.rst.txt b/Documentation/_CodeSnippets/FileStructure/IndexRst.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/IndexRst.rst.txt rename to Documentation/_CodeSnippets/FileStructure/IndexRst.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/ReadmeMd.rst.txt b/Documentation/_CodeSnippets/FileStructure/ReadmeMd.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/ReadmeMd.rst.txt rename to Documentation/_CodeSnippets/FileStructure/ReadmeMd.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/ReadmeMdStandalone.rst.txt b/Documentation/_CodeSnippets/FileStructure/ReadmeMdStandalone.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/ReadmeMdStandalone.rst.txt rename to Documentation/_CodeSnippets/FileStructure/ReadmeMdStandalone.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/ReadmeRst.rst.txt b/Documentation/_CodeSnippets/FileStructure/ReadmeRst.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/ReadmeRst.rst.txt rename to Documentation/_CodeSnippets/FileStructure/ReadmeRst.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/ReadmeRstStandalone.rst.txt b/Documentation/_CodeSnippets/FileStructure/ReadmeRstStandalone.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/ReadmeRstStandalone.rst.txt rename to Documentation/_CodeSnippets/FileStructure/ReadmeRstStandalone.rst.txt diff --git a/Documentation/CodeSnippets/FileStructure/SettingsCfg.rst.txt b/Documentation/_CodeSnippets/FileStructure/SettingsCfg.rst.txt similarity index 100% rename from Documentation/CodeSnippets/FileStructure/SettingsCfg.rst.txt rename to Documentation/_CodeSnippets/FileStructure/SettingsCfg.rst.txt diff --git a/Documentation/CodeSnippets/LiteralIncludes/example.yaml b/Documentation/_CodeSnippets/LiteralIncludes/example.yaml similarity index 100% rename from Documentation/CodeSnippets/LiteralIncludes/example.yaml rename to Documentation/_CodeSnippets/LiteralIncludes/example.yaml diff --git a/Documentation/CodeSnippets/LiteralIncludes/example_de.yaml b/Documentation/_CodeSnippets/LiteralIncludes/example_de.yaml similarity index 100% rename from Documentation/CodeSnippets/LiteralIncludes/example_de.yaml rename to Documentation/_CodeSnippets/LiteralIncludes/example_de.yaml diff --git a/Documentation/CodeSnippets/_Makefile b/Documentation/_CodeSnippets/_Makefile similarity index 100% rename from Documentation/CodeSnippets/_Makefile rename to Documentation/_CodeSnippets/_Makefile diff --git a/Documentation/CodeSnippets/_documentation.yml b/Documentation/_CodeSnippets/_documentation.yml similarity index 100% rename from Documentation/CodeSnippets/_documentation.yml rename to Documentation/_CodeSnippets/_documentation.yml diff --git a/Documentation/CodeSnippets/codesnippets.php b/Documentation/_CodeSnippets/codesnippets.php similarity index 97% rename from Documentation/CodeSnippets/codesnippets.php rename to Documentation/_CodeSnippets/codesnippets.php index 595ebb31..870fa0bb 100644 --- a/Documentation/CodeSnippets/codesnippets.php +++ b/Documentation/_CodeSnippets/codesnippets.php @@ -1,7 +1,7 @@