diff --git a/Documentation/Advanced/CodingGuidelines.rst b/Documentation/Advanced/CodingGuidelines.rst index 2492d401..47721f92 100644 --- a/Documentation/Advanced/CodingGuidelines.rst +++ b/Documentation/Advanced/CodingGuidelines.rst @@ -175,7 +175,7 @@ However, adhering to the standard for TYPO3 documentation makes it easier for other contributors to find their way around a file and pick the correct underlining for the header level. -Use the :ref:`conventions for headlines `. +Use the :ref:`conventions for headlines `. This underlining is used **per (.rst) file**. It does not matter where in the toctree the file is. You always start with underlining for level 1 (title) in each diff --git a/Documentation/Advanced/ContentStyleGuide.rst b/Documentation/Advanced/ContentStyleGuide.rst index d73a0dd5..4614963c 100644 --- a/Documentation/Advanced/ContentStyleGuide.rst +++ b/Documentation/Advanced/ContentStyleGuide.rst @@ -101,7 +101,7 @@ Examples: This applies to **all headers** on a page, not just the top level header (title). In reST, headers are created by underlining / overlining with (`====`, `----`, etc.) -as described in :ref:`headlines and sections `: +as described in :ref:`headlines and sections `: .. code-block:: rst diff --git a/Documentation/Basics/RstCheatSheet.rst b/Documentation/Basics/RstCheatSheet.rst index c84dea6b..35e0fd55 100644 --- a/Documentation/Basics/RstCheatSheet.rst +++ b/Documentation/Basics/RstCheatSheet.rst @@ -1,7 +1,7 @@ :navigation-title: ReST Cheat Sheet .. include:: /Includes.rst.txt .. _writing-rest-introduction: -.. _Formatting-with-reST: +.. _formatting-with-rest: .. _rest-quick-start: .. _rest-cheat-sheet: diff --git a/Documentation/Howto/Contribute/HowYouCanHelp.rst b/Documentation/Howto/Contribute/HowYouCanHelp.rst index 0e69bbd2..bb58ecd7 100644 --- a/Documentation/Howto/Contribute/HowYouCanHelp.rst +++ b/Documentation/Howto/Contribute/HowYouCanHelp.rst @@ -140,7 +140,7 @@ Here are some examples: Example of a sequence diagram about request handling -* :ref:`Get started with PlantUML diagrams ` +* :ref:`Get started with PlantUML diagrams ` .. _docs-official-how-you-can-help-replace-outdated-images: diff --git a/Documentation/Howto/EditLocal.rst b/Documentation/Howto/EditLocal.rst index eb621497..677a1c88 100644 --- a/Documentation/Howto/EditLocal.rst +++ b/Documentation/Howto/EditLocal.rst @@ -215,7 +215,7 @@ More information For more information in this guide: -* :ref:`reST cheat sheet ` +* :ref:`reST cheat sheet ` * `Rendering Documentation With Docker `__ * :ref:`Review policy ` diff --git a/Documentation/Howto/Migration/Index.rst b/Documentation/Howto/Migration/Index.rst index bb74f9db..eec01afc 100644 --- a/Documentation/Howto/Migration/Index.rst +++ b/Documentation/Howto/Migration/Index.rst @@ -26,7 +26,7 @@ In the transition period the GitHub action of the official rendering process det :file:`Documentation/guides.xml` is present and then automatically switches to the PHP-based rendering. -.. _migrate_guides_xml: +.. _migrate-guides-xml: Create the settings file :file:`Documentation/guides.xml` ========================================================= diff --git a/Documentation/Reference/FileStructure.rst b/Documentation/Reference/FileStructure.rst index 0e76722a..eadf0554 100644 --- a/Documentation/Reference/FileStructure.rst +++ b/Documentation/Reference/FileStructure.rst @@ -217,7 +217,7 @@ Read more about :ref:`configuring the rendering in guides.xml `. .. hint:: If you are migrating from the legacy Sphinx-based rendering and still have a :file:`Documentation/Settings.cfg` you can use an automatic migration - tool to :ref:`migrate the settings.cfg into a guides.xml `. + tool to :ref:`migrate the settings.cfg into a guides.xml `. Example: diff --git a/Documentation/Reference/GuidesXml.rst b/Documentation/Reference/GuidesXml.rst index d15c5b67..61189fed 100644 --- a/Documentation/Reference/GuidesXml.rst +++ b/Documentation/Reference/GuidesXml.rst @@ -30,7 +30,7 @@ And follow the interactive question. .. hint:: If you are migrating from the legacy Sphinx-based rendering and still have a :file:`Documentation/Settings.cfg` you can use an automatic migration - tool to :ref:`migrate the Settings.cfg into a guides.xml ` + tool to :ref:`migrate the Settings.cfg into a guides.xml ` .. _guides-xml-api: @@ -546,7 +546,7 @@ And follow the interactive question. a private Gitlab or another issue tool, Make an internal page and link it like `/SomePath/MyIssueReport`. - .. _settings-guides-preferred_typo3_version: + .. _settings-guides-preferred-typo3-version: .. confval:: typo3-core-preferred :name: guides-extension-typo3-core-preferred diff --git a/Documentation/Reference/ReStructuredText/Graphics/Diagrams.rst b/Documentation/Reference/ReStructuredText/Graphics/Diagrams.rst index 1d5707a7..e96613d6 100644 --- a/Documentation/Reference/ReStructuredText/Graphics/Diagrams.rst +++ b/Documentation/Reference/ReStructuredText/Graphics/Diagrams.rst @@ -2,7 +2,7 @@ .. index:: ! Diagrams Diagrams; PlantUML -.. _PlantUML-diagrams: +.. _plantuml-diagrams: ================= PlantUML diagrams @@ -28,7 +28,7 @@ This will be rendered as: class -> otherClass : message -.. _PlantUML-diagrams-included: +.. _plantuml-diagrams-included: Include a PlantUML file ======================= diff --git a/Documentation/Reference/ReStructuredText/Lists/DefinitionLists.rst b/Documentation/Reference/ReStructuredText/Lists/DefinitionLists.rst index 0f47e117..85b7c076 100644 --- a/Documentation/Reference/ReStructuredText/Lists/DefinitionLists.rst +++ b/Documentation/Reference/ReStructuredText/Lists/DefinitionLists.rst @@ -1,6 +1,6 @@ .. include:: /Includes.rst.txt .. index:: reST; Definition lists -.. _Styled-Definition-Lists: +.. _styled-definition-lists: ================ Definition lists @@ -146,7 +146,7 @@ Source: .. code-block:: rst - .. _label-parameterAbc: + .. _label-parameterabc: .. rst-class:: dl-parameters parameterAbc @@ -157,7 +157,7 @@ Source: Text describing parameterAbc ... - .. _label-parameterBcd: + .. _label-parameterbcd: .. rst-class:: dl-parameters parameterBcd @@ -171,7 +171,7 @@ Source: Rendering result: -.. _label-parameterAbc: +.. _label-parameterabc: .. rst-class:: dl-parameters parameterAbc @@ -182,7 +182,7 @@ parameterAbc Text describing parameterAbc ... -.. _label-parameterBcd: +.. _label-parameterbcd: .. rst-class:: dl-parameters parameterBcd @@ -199,12 +199,12 @@ Source: .. code-block:: rst - Here we link to :ref:`A link text for parameterAbc `. + Here we link to :ref:`A link text for parameterAbc `. - Here we link to :ref:`A link text for parameterBcd `. + Here we link to :ref:`A link text for parameterBcd `. Result: -Here we link to :ref:`A link text for parameterAbc `. +Here we link to :ref:`A link text for parameterAbc `. -Here we link to :ref:`A link text for parameterBcd `. +Here we link to :ref:`A link text for parameterBcd `.