diff --git a/Documentation/About.rst b/Documentation/About.rst index 0f5baa79..40d9570d 100644 --- a/Documentation/About.rst +++ b/Documentation/About.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. _about: ================ diff --git a/Documentation/BasicPrinciples.rst b/Documentation/BasicPrinciples.rst index e59b3fe3..dc1a23ff 100644 --- a/Documentation/BasicPrinciples.rst +++ b/Documentation/BasicPrinciples.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. _basic-principles: ================ diff --git a/Documentation/GeneralConventions/CodingGuidelines.rst b/Documentation/GeneralConventions/CodingGuidelines.rst index c986538c..bd3c7c2f 100644 --- a/Documentation/GeneralConventions/CodingGuidelines.rst +++ b/Documentation/GeneralConventions/CodingGuidelines.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: pair: Coding guidelines; reST .. _format-rest-cgl: @@ -156,9 +155,9 @@ Use the conventions as defined in :ref:`Headlines-and-sections`. 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 -file:: - +file: +.. code-block:: rst ======== 1. Title @@ -200,19 +199,25 @@ file:: How to add version hints ======================== -Example, how you can point out **deprecations**:: +Example, how you can point out **deprecations**: + +.. code-block:: rst .. deprecated:: 10.2 The hook shown here is deprecated since TYPO3 10.2 - use a custom :ref:`PSR-15 middleware` instead. -New **feature**:: +New **feature**: + +.. code-block:: rst .. versionadded:: 10.2 Starting with TYPO3 10.2 hooks and signals have been replaced by a PSR-14 based event dispatching system. -Changes:: +Changes: + +.. code-block:: rst .. versionchanged:: 2.3.1 This feature was changed ... diff --git a/Documentation/GeneralConventions/ContentStyleGuide.rst b/Documentation/GeneralConventions/ContentStyleGuide.rst index 90403316..d1f44d45 100644 --- a/Documentation/GeneralConventions/ContentStyleGuide.rst +++ b/Documentation/GeneralConventions/ContentStyleGuide.rst @@ -73,7 +73,9 @@ 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 ================= This is the title diff --git a/Documentation/GeneralConventions/Format.rst b/Documentation/GeneralConventions/Format.rst index a3b95f90..229f1678 100644 --- a/Documentation/GeneralConventions/Format.rst +++ b/Documentation/GeneralConventions/Format.rst @@ -57,14 +57,14 @@ If you’re encountering problems with the rendering of your markdown files, con reST vs. Markdown ================= -Victor Zverovich makes the comparison:: +Victor Zverovich makes the comparison: According to John Gruber, the inventor of Markdown, “Markdown’s syntax is intended for one purpose: to be used as a format for writing for the web.” and, in particular, it supports inline HTML. reStructuredText on the other hand is specifically designed for writing technical documentation. -readthedocs:: +readthedocs: "It should be noted that Commonmark doesn’t support a lot of the concepts that RST lets you represent. In particular, there is no standardized way in Commonmark to represent inline or block levels constructs. diff --git a/Documentation/GeneralConventions/Glossary.rst b/Documentation/GeneralConventions/Glossary.rst index db9178de..266fbf89 100644 --- a/Documentation/GeneralConventions/Glossary.rst +++ b/Documentation/GeneralConventions/Glossary.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Spelling; Reference Preferred terms @@ -15,8 +14,6 @@ Spelling, terms and glossary Spelling ======== -.. default-role:: guilabel - Pick the spelling and recommended terms from this list. @@ -177,10 +174,6 @@ W -.. default-role:: php - - - Terms ===== @@ -202,3 +195,5 @@ third party extension ViewHelper Our community agreed on this spelling. + +.. default-role:: code diff --git a/Documentation/GeneralConventions/GuidelinesForImages.rst b/Documentation/GeneralConventions/GuidelinesForImages.rst index 5b0de5a1..ec8e907e 100644 --- a/Documentation/GeneralConventions/GuidelinesForImages.rst +++ b/Documentation/GeneralConventions/GuidelinesForImages.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: ! Images Screenshots diff --git a/Documentation/GeneralConventions/Index.rst b/Documentation/GeneralConventions/Index.rst index 05caa765..8ad8928d 100644 --- a/Documentation/GeneralConventions/Index.rst +++ b/Documentation/GeneralConventions/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Documentation; Content style guide .. _general-conventions: .. _conventions: @@ -41,7 +40,9 @@ be found in the subchapters. #. Version hints :ref:`version-hints` describes how to add version hints for new sections - or chapters:: + or chapters: + + .. code-block:: rst .. deprecated:: 10.2 The hook shown here is deprecated since TYPO3 10.2 - use a custom @@ -65,7 +66,9 @@ be found in the subchapters. #. Coding guidelines for headers - Headline underline should follow :ref:`rest-cgl-headline-underlines`:: + Headline underline should follow :ref:`rest-cgl-headline-underlines` + + .. code-block:: rst ===== Title @@ -86,7 +89,9 @@ be found in the subchapters. #. Refer to elements in the GUI with :rst:`:guilabel:` - Example:: + Example: + + .. code-block:: rst :guilabel:`Admin Tools > Extensions` diff --git a/Documentation/GeneralConventions/Licenses.rst b/Documentation/GeneralConventions/Licenses.rst index 7d8d990f..45a0b02c 100644 --- a/Documentation/GeneralConventions/Licenses.rst +++ b/Documentation/GeneralConventions/Licenses.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Documentation; License Documentation; Openpub license diff --git a/Documentation/GeneralConventions/ReviewInformation.rst b/Documentation/GeneralConventions/ReviewInformation.rst index 6dbfd6d4..a88f5636 100644 --- a/Documentation/GeneralConventions/ReviewInformation.rst +++ b/Documentation/GeneralConventions/ReviewInformation.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: ! Reviewing manuals .. _guidelines-for-reviewing: diff --git a/Documentation/HowToAddTranslation/Index.rst b/Documentation/HowToAddTranslation/Index.rst index 2b30547d..700734e5 100644 --- a/Documentation/HowToAddTranslation/Index.rst +++ b/Documentation/HowToAddTranslation/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Documentation; Translation .. _add-translation: diff --git a/Documentation/Maintainers/BackportChanges.rst b/Documentation/Maintainers/BackportChanges.rst index 6c4c2049..a268a0e6 100644 --- a/Documentation/Maintainers/BackportChanges.rst +++ b/Documentation/Maintainers/BackportChanges.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: shell .. index:: Changes; Backporting .. _backport-changes: diff --git a/Documentation/Maintainers/Changelog.rst b/Documentation/Maintainers/Changelog.rst index 7acbfd69..ce2a3436 100644 --- a/Documentation/Maintainers/Changelog.rst +++ b/Documentation/Maintainers/Changelog.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Documentation; Update Documentation; New releases diff --git a/Documentation/Maintainers/Tools.rst b/Documentation/Maintainers/Tools.rst index d428e549..5f71c941 100644 --- a/Documentation/Maintainers/Tools.rst +++ b/Documentation/Maintainers/Tools.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: shell .. index:: Changes; Backporting .. _tools_of_the_documentation_team: diff --git a/Documentation/Migration/Index.rst b/Documentation/Migration/Index.rst index eecda58b..6e6c64d4 100644 --- a/Documentation/Migration/Index.rst +++ b/Documentation/Migration/Index.rst @@ -383,7 +383,7 @@ To be discussed: Index generation (glossary) The Sphinx rendering allowed to utilize a syntax like the following to add indexes to your documentation: -.. code-block:: +.. code-block:: plaintext :caption: Documentation/Index.rst .. index:: diff --git a/Documentation/RenderingDocs/Index.rst b/Documentation/RenderingDocs/Index.rst index 4d5d69fa..662a7a51 100644 --- a/Documentation/RenderingDocs/Index.rst +++ b/Documentation/RenderingDocs/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. Index:: pair: Documentation; Rendering Rendering; Locally diff --git a/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst b/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst index 44f8f669..cd93790e 100644 --- a/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst +++ b/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: pair: Documentation; System extensions .. _contribute-to-system-extension: diff --git a/Documentation/WritingDocForExtension/ContributeToThirdPartyExtension.rst b/Documentation/WritingDocForExtension/ContributeToThirdPartyExtension.rst index 26a7fcbb..b24100f8 100644 --- a/Documentation/WritingDocForExtension/ContributeToThirdPartyExtension.rst +++ b/Documentation/WritingDocForExtension/ContributeToThirdPartyExtension.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: pair: Documentation; Third-party extensions .. _contribute-to-3rdparty-extension: diff --git a/Documentation/WritingDocForExtension/Index.rst b/Documentation/WritingDocForExtension/Index.rst index e4dbd5a1..002c30d6 100644 --- a/Documentation/WritingDocForExtension/Index.rst +++ b/Documentation/WritingDocForExtension/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Documentation; Extension .. _writing-doc-for-ext-start: .. _how-to-start-docs-extension: diff --git a/Documentation/WritingDocForExtension/ReregisterVersions.rst b/Documentation/WritingDocForExtension/ReregisterVersions.rst index c7396d19..258d700d 100644 --- a/Documentation/WritingDocForExtension/ReregisterVersions.rst +++ b/Documentation/WritingDocForExtension/ReregisterVersions.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: bash .. _reregister-versions: @@ -17,7 +16,9 @@ The created branches can be pushed, to trigger the webhook. Once done, those branches can be removed again, to keep the repository clean. With a lot of versions release this task can get very tedious. -To get over it in an efficient way, the following script can help with the task:: +To get over it in an efficient way, the following script can help with the task: + +.. code-block:: bash #!/bin/sh @@ -40,7 +41,9 @@ To get over it in an efficient way, the following script can help with the task: rm -rf "/tmp/$EXTENSION" The script needs to be called with the repository name. -If the script is saved with the name :file:`trigger_documentation_push.sh` this would be executed using this example:: +If the script is saved with the name :file:`trigger_documentation_push.sh` this would be executed using this example: + +.. code-block:: rst sh trigger_documentation_push.sh evoWeb/sf_register diff --git a/Documentation/WritingDocsOfficial/GithubMethod.rst b/Documentation/WritingDocsOfficial/GithubMethod.rst index 37c78de2..93c4525e 100644 --- a/Documentation/WritingDocsOfficial/GithubMethod.rst +++ b/Documentation/WritingDocsOfficial/GithubMethod.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: pair: Official documentation; "Edit on GitHub" .. _docs-contribute-github-method: diff --git a/Documentation/WritingDocsOfficial/HowYouCanHelp.rst b/Documentation/WritingDocsOfficial/HowYouCanHelp.rst index a0849e8b..377e70ca 100644 --- a/Documentation/WritingDocsOfficial/HowYouCanHelp.rst +++ b/Documentation/WritingDocsOfficial/HowYouCanHelp.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. _docs-official-how-you-can-help: .. _how-to-contribute: diff --git a/Documentation/WritingDocsOfficial/Index.rst b/Documentation/WritingDocsOfficial/Index.rst index 2bbcf88f..67403964 100644 --- a/Documentation/WritingDocsOfficial/Index.rst +++ b/Documentation/WritingDocsOfficial/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Official documentation .. _contribute: .. _docs-contribute: diff --git a/Documentation/WritingDocsOfficial/LocalEditing.rst b/Documentation/WritingDocsOfficial/LocalEditing.rst index 044ba109..47f64844 100644 --- a/Documentation/WritingDocsOfficial/LocalEditing.rst +++ b/Documentation/WritingDocsOfficial/LocalEditing.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Official documentation; Local editing .. _docs-contribute-git-docker: diff --git a/Documentation/WritingReST/BasicRestSyntax.rst b/Documentation/WritingReST/BasicRestSyntax.rst index 1b08e071..8834e9aa 100644 --- a/Documentation/WritingReST/BasicRestSyntax.rst +++ b/Documentation/WritingReST/BasicRestSyntax.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Syntax .. _basic-rest-syntax: @@ -17,7 +16,9 @@ Paragraphs ========== New paragraphs in the output are created by an empty line -between two paragraphs in your reST file:: +between two paragraphs in your reST file: + +.. code-block:: rst This is a paragraph. @@ -29,12 +30,16 @@ between two paragraphs in your reST file:: Comments ======== -Comments can be written like this:: +Comments can be written like this: + +.. code-block:: rst .. this is a comment .. with another line -Or like this:: +Or like this: + +.. code-block:: rst .. this is a comment with another line @@ -73,6 +78,8 @@ If you want to use a character, which would create some special reST markup, with its normal meaning, you must escape it with a prepended "\". For example surrounding text with "*" signs normally makes it show up in italics. By -escaping the special characters "*" you make the stars normal text characters:: +escaping the special characters "*" you make the stars normal text characters: + +.. code-block:: rst \*non-italic\* diff --git a/Documentation/WritingReST/CheatSheet.rst b/Documentation/WritingReST/CheatSheet.rst index 99dc32d5..3d221df4 100644 --- a/Documentation/WritingReST/CheatSheet.rst +++ b/Documentation/WritingReST/CheatSheet.rst @@ -458,7 +458,9 @@ This is an example with a code block (:rst:`::`) embedded in the sections. 1. Embed an image - Source:: + Source: + + .. code-block:: rst /Images/a4.jpg :class: with-shadow diff --git a/Documentation/WritingReST/Index.rst b/Documentation/WritingReST/Index.rst index 09372633..ba3e84d0 100644 --- a/Documentation/WritingReST/Index.rst +++ b/Documentation/WritingReST/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reStructuredText reST diff --git a/Documentation/WritingReST/Introduction.rst b/Documentation/WritingReST/Introduction.rst index 44336392..a8e8434d 100644 --- a/Documentation/WritingReST/Introduction.rst +++ b/Documentation/WritingReST/Introduction.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. _writing-rest-introduction: @@ -16,7 +15,9 @@ file ending of reST files is :file:`.rst`. reStructuredText is a markup language for writing documentation. You can edit the source files using plain text and add reST markup where needed. -For example to create section headers, you use underlines:: +For example to create section headers, you use underlines: + +.. code-block:: rst ======== Header 1 diff --git a/Documentation/WritingReST/Reference/Code/Codeblocks.rst b/Documentation/WritingReST/Reference/Code/Codeblocks.rst index c252f252..be870870 100644 --- a/Documentation/WritingReST/Reference/Code/Codeblocks.rst +++ b/Documentation/WritingReST/Reference/Code/Codeblocks.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Code blocks reST; syntax highlighting @@ -490,11 +489,10 @@ You can change these code blocks like this: :caption: UpdateShorthandCode.diff The extension already contains some unit tests that extend `typo3/testing-framework`'s base - -unit test class in directory :file:`Tests/Unit/Hooks` (stripped):: - +unit test class: - + - +.. code-block:: php - + :caption: /Tests/Unit/Hooks/DataHandlerFlushByTagHookTest.php + -unit test class in directory :file:`Tests/Unit/Hooks` (stripped): + + .. code-block:: php + :caption: /Tests/Unit/Hooks/DataHandlerFlushByTagHookTest.php `__. -Example: You want 'haskell'? Define that role as derivative of 'code':: +Example: You want 'haskell'? Define that role as derivative of 'code': + +.. code-block:: rst .. role:: haskell(code) -You may then write:: +You may then write: + +.. code-block:: rst Here is some :haskell:`haskell inline code` in the sentence. diff --git a/Documentation/WritingReST/Reference/Code/Phpdomain.rst b/Documentation/WritingReST/Reference/Code/Phpdomain.rst index dec9275e..f8c12b30 100644 --- a/Documentation/WritingReST/Reference/Code/Phpdomain.rst +++ b/Documentation/WritingReST/Reference/Code/Phpdomain.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; PHP domain .. _rest-phpdomain: diff --git a/Documentation/WritingReST/Reference/Content/Accordion.rst b/Documentation/WritingReST/Reference/Content/Accordion.rst index 3a6f0927..5e0dbdd5 100644 --- a/Documentation/WritingReST/Reference/Content/Accordion.rst +++ b/Documentation/WritingReST/Reference/Content/Accordion.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Accordion .. _rest-accordion: diff --git a/Documentation/WritingReST/Reference/Content/Admonitions.rst b/Documentation/WritingReST/Reference/Content/Admonitions.rst index abb392a9..b537c80b 100644 --- a/Documentation/WritingReST/Reference/Content/Admonitions.rst +++ b/Documentation/WritingReST/Reference/Content/Admonitions.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Admonitions .. _rest-admonitions: diff --git a/Documentation/WritingReST/Reference/Content/BoldItalic.rst b/Documentation/WritingReST/Reference/Content/BoldItalic.rst index 2676a936..c3bf53fe 100644 --- a/Documentation/WritingReST/Reference/Content/BoldItalic.rst +++ b/Documentation/WritingReST/Reference/Content/BoldItalic.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Font styles .. _rest-bold-italic: diff --git a/Documentation/WritingReST/Reference/Content/Cards.rst b/Documentation/WritingReST/Reference/Content/Cards.rst index c6bc9f71..6f1dc97d 100644 --- a/Documentation/WritingReST/Reference/Content/Cards.rst +++ b/Documentation/WritingReST/Reference/Content/Cards.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Cards .. _rest-cards: diff --git a/Documentation/WritingReST/Reference/Content/Comments.rst b/Documentation/WritingReST/Reference/Content/Comments.rst index bf778af9..a2170cbf 100644 --- a/Documentation/WritingReST/Reference/Content/Comments.rst +++ b/Documentation/WritingReST/Reference/Content/Comments.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Comments .. _writing-rest-comments: diff --git a/Documentation/WritingReST/Reference/Content/Index.rst b/Documentation/WritingReST/Reference/Content/Index.rst index 660c77cf..533a9295 100644 --- a/Documentation/WritingReST/Reference/Content/Index.rst +++ b/Documentation/WritingReST/Reference/Content/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. _rest-content: =================================== diff --git a/Documentation/WritingReST/Reference/Content/SpecialCharacters.rst b/Documentation/WritingReST/Reference/Content/SpecialCharacters.rst index 027680f7..3d964bb5 100644 --- a/Documentation/WritingReST/Reference/Content/SpecialCharacters.rst +++ b/Documentation/WritingReST/Reference/Content/SpecialCharacters.rst @@ -108,7 +108,6 @@ STAR Using U+2420 symbol for space ============================= -.. highlight:: rst Code ---- diff --git a/Documentation/WritingReST/Reference/Content/Tables.rst b/Documentation/WritingReST/Reference/Content/Tables.rst index 776f3f5f..bea9f0c9 100644 --- a/Documentation/WritingReST/Reference/Content/Tables.rst +++ b/Documentation/WritingReST/Reference/Content/Tables.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Tables .. _rest-tables: diff --git a/Documentation/WritingReST/Reference/Content/Tabs.rst b/Documentation/WritingReST/Reference/Content/Tabs.rst index a77ba935..932aebfa 100644 --- a/Documentation/WritingReST/Reference/Content/Tabs.rst +++ b/Documentation/WritingReST/Reference/Content/Tabs.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Tabs .. _rest-tabs: diff --git a/Documentation/WritingReST/Reference/Content/YoutubeVideos.rst b/Documentation/WritingReST/Reference/Content/YoutubeVideos.rst index 938ee79e..75ff3164 100644 --- a/Documentation/WritingReST/Reference/Content/YoutubeVideos.rst +++ b/Documentation/WritingReST/Reference/Content/YoutubeVideos.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; YouTube videos reST directives; youtube diff --git a/Documentation/WritingReST/Reference/Graphics/Diagrams.rst b/Documentation/WritingReST/Reference/Graphics/Diagrams.rst index 340f741c..2ea6d75f 100644 --- a/Documentation/WritingReST/Reference/Graphics/Diagrams.rst +++ b/Documentation/WritingReST/Reference/Graphics/Diagrams.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: ! Diagrams Diagrams; PlantUML diff --git a/Documentation/WritingReST/Reference/Graphics/Images.rst b/Documentation/WritingReST/Reference/Graphics/Images.rst index a74abf55..aad3c960 100644 --- a/Documentation/WritingReST/Reference/Graphics/Images.rst +++ b/Documentation/WritingReST/Reference/Graphics/Images.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: pair: reST; Images .. _how-to-document-images: .. _rest-images: diff --git a/Documentation/WritingReST/Reference/Index.rst b/Documentation/WritingReST/Reference/Index.rst index a981a593..9dda0465 100644 --- a/Documentation/WritingReST/Reference/Index.rst +++ b/Documentation/WritingReST/Reference/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Reference .. _rest-reference: diff --git a/Documentation/WritingReST/Reference/Lists/BignumLists.rst b/Documentation/WritingReST/Reference/Lists/BignumLists.rst index 14721b68..55c6c2a6 100644 --- a/Documentation/WritingReST/Reference/Lists/BignumLists.rst +++ b/Documentation/WritingReST/Reference/Lists/BignumLists.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Styled numbered sections reST classes; bignums @@ -15,7 +14,9 @@ Styled numbered sections (bignums) With XXL Big Numbers ==================== -*Source:* :: +*Source:* : + +.. code-block:: rst .. rst-class:: bignums-xxl @@ -52,7 +53,9 @@ With XXL Big Numbers With Big Numbers ================ -*Source:* :: +*Source:* : + +.. code-block:: rst .. rst-class:: bignums @@ -89,7 +92,9 @@ With Big Numbers - Tip Uses the same color as background, that is used in a tip textblock. -*Source:* :: +*Source:* : + +.. code-block:: rst .. rst-class:: bignums-tip @@ -118,8 +123,9 @@ Uses the same color as background, that is used in a tip textblock. With Big Numbers - Attention ============================= +*Source:* : -*Source:* :: +.. code-block:: rst .. rst-class:: bignums-attention @@ -151,7 +157,9 @@ With Big Numbers - Important ============================ -*Source:* :: +*Source:* : + +.. code-block:: rst .. rst-class:: bignums-important @@ -181,7 +189,9 @@ With Big Numbers - Important With Big Numbers - Warning ========================== -*Source:* :: +*Source:* : + +.. code-block:: rst .. rst-class:: bignums-warning @@ -213,7 +223,9 @@ Nested bignums-xxl > bignums > Normally Styled ============================================== -*Source:* :: +*Source:* : + +.. code-block:: rst .. rst-class:: bignums-xxl @@ -271,7 +283,9 @@ More Examples of Nesting #. Check the requirements #. Machine accessible? - #. Is `abc` installed? Run:: + #. Is `abc` installed? Run: + + .. code-block:: rst which abc diff --git a/Documentation/WritingReST/Reference/Lists/BulletLists.rst b/Documentation/WritingReST/Reference/Lists/BulletLists.rst index 5c823db8..de60d5cd 100644 --- a/Documentation/WritingReST/Reference/Lists/BulletLists.rst +++ b/Documentation/WritingReST/Reference/Lists/BulletLists.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Bullet lists .. _rest-unordered-lists: diff --git a/Documentation/WritingReST/Reference/Lists/DefinitionLists.rst b/Documentation/WritingReST/Reference/Lists/DefinitionLists.rst index 19044222..b6739234 100644 --- a/Documentation/WritingReST/Reference/Lists/DefinitionLists.rst +++ b/Documentation/WritingReST/Reference/Lists/DefinitionLists.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Definition lists .. _Styled-Definition-Lists: @@ -109,7 +108,9 @@ Attention: The text roles `ascpect` and `sep` (for separator) need to be defined. The usual way of defining them is by having these lines in the -:file:`Documentation/Includes.rst.txt` file. Add these lines:: +:file:`Documentation/Includes.rst.txt` file. Add these lines: + +.. code-block:: rst .. role:: aspect (emphasis) .. role:: sep (strong) diff --git a/Documentation/WritingReST/Reference/Lists/Index.rst b/Documentation/WritingReST/Reference/Lists/Index.rst index 1db5f690..e25d167b 100644 --- a/Documentation/WritingReST/Reference/Lists/Index.rst +++ b/Documentation/WritingReST/Reference/Lists/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. _rest-lists: ===== diff --git a/Documentation/WritingReST/Reference/Lists/ListItemsAsButtons.rst b/Documentation/WritingReST/Reference/Lists/ListItemsAsButtons.rst index b24747dc..e30bb6c3 100644 --- a/Documentation/WritingReST/Reference/Lists/ListItemsAsButtons.rst +++ b/Documentation/WritingReST/Reference/Lists/ListItemsAsButtons.rst @@ -1,6 +1,5 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Buttons .. _list-items-as-buttons: @@ -25,7 +24,9 @@ the items of an unordered list appear as "buttons". To put this into action the `
    ` tag needs to have one of the following (css-) classes. To assign a class place a `.. rst-class:: THENAME` right in front of -the list like so:: +the list like so: + +.. code-block:: rst .. rst-class:: horizbuttons-attention-m diff --git a/Documentation/WritingReST/Reference/Lists/NumberedLists.rst b/Documentation/WritingReST/Reference/Lists/NumberedLists.rst index ff9bd0df..7abf9b79 100644 --- a/Documentation/WritingReST/Reference/Lists/NumberedLists.rst +++ b/Documentation/WritingReST/Reference/Lists/NumberedLists.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Numbered lists .. _numbered-lists: @@ -8,7 +7,9 @@ Numbered lists ============== -*Source:* :: +*Source:* : + +.. code-block:: rst #. abc #. bcd diff --git a/Documentation/WritingReST/Reference/Menus/ContentMenu.rst b/Documentation/WritingReST/Reference/Menus/ContentMenu.rst index c8c55b14..f7ac3771 100644 --- a/Documentation/WritingReST/Reference/Menus/ContentMenu.rst +++ b/Documentation/WritingReST/Reference/Menus/ContentMenu.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: Menus; Content .. _content-menu: @@ -10,7 +9,9 @@ Content menu You can display the titles of the current page as a content menu. -The simplest content menu can be created like this:: +The simplest content menu can be created like this: + +.. code-block:: rst .. contents:: :local: diff --git a/Documentation/WritingReST/Reference/Menus/HeadlinesAndSection.rst b/Documentation/WritingReST/Reference/Menus/HeadlinesAndSection.rst index c6559184..5e570f7f 100644 --- a/Documentation/WritingReST/Reference/Menus/HeadlinesAndSection.rst +++ b/Documentation/WritingReST/Reference/Menus/HeadlinesAndSection.rst @@ -1,6 +1,5 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: pair: reST; Headlines pair: reST; Titles @@ -19,13 +18,17 @@ is split into "sections" instead. Those sections are identified by titles which 1. Use underlining plus overlining with `===` for the first section title of a file. The first section title is the "document title" (**doctitle**) of that - file and will appear in the menu. Every .rst file should have a doctitle:: + file and will appear in the menu. Every .rst file should have a doctitle: + +.. code-block:: rst ======== DocTitle ======== -2. Then use underlining only:: +2. Then use underlining only: + +.. code-block:: rst 1. ========== for the first level 2. ---------- for the second level @@ -34,7 +37,9 @@ is split into "sections" instead. Those sections are identified by titles which 3. More levels will be rarely used. For sake of completeness here is the whole hierarchy the automatic conversion tools uses. Stick to this order if more - levels are needed:: + levels are needed: + +.. code-block:: rst 5. '''''''''' 6. ^^^^^^^^^^ diff --git a/Documentation/WritingReST/Reference/Menus/IncludingFiles.rst b/Documentation/WritingReST/Reference/Menus/IncludingFiles.rst index 123a33b5..50562085 100644 --- a/Documentation/WritingReST/Reference/Menus/IncludingFiles.rst +++ b/Documentation/WritingReST/Reference/Menus/IncludingFiles.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Including files reST directives; include diff --git a/Documentation/WritingReST/Reference/Menus/Index.rst b/Documentation/WritingReST/Reference/Menus/Index.rst index 37a22b41..20690abf 100644 --- a/Documentation/WritingReST/Reference/Menus/Index.rst +++ b/Documentation/WritingReST/Reference/Menus/Index.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. _rest-menu: .. _rest-page-structure: diff --git a/Documentation/WritingReST/Reference/Menus/MenuHierarchy.rst b/Documentation/WritingReST/Reference/Menus/MenuHierarchy.rst index a66762a6..6e52973d 100644 --- a/Documentation/WritingReST/Reference/Menus/MenuHierarchy.rst +++ b/Documentation/WritingReST/Reference/Menus/MenuHierarchy.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Toctree Manual; Hierarchical structure diff --git a/Documentation/WritingReST/Reference/Menus/Orphans.rst b/Documentation/WritingReST/Reference/Menus/Orphans.rst index aad78b73..c289a286 100644 --- a/Documentation/WritingReST/Reference/Menus/Orphans.rst +++ b/Documentation/WritingReST/Reference/Menus/Orphans.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: pair: reST; Orphaned pages .. _rest-orphans: diff --git a/Documentation/WritingReST/Reference/Menus/Sidebar.rst b/Documentation/WritingReST/Reference/Menus/Sidebar.rst index 7ebfeda0..84ca1c2f 100644 --- a/Documentation/WritingReST/Reference/Menus/Sidebar.rst +++ b/Documentation/WritingReST/Reference/Menus/Sidebar.rst @@ -1,5 +1,4 @@ .. include:: /Includes.rst.txt -.. highlight:: rst .. index:: reST; Sidebar .. _rest-sidebar: diff --git a/Documentation/guides.xml b/Documentation/guides.xml index 6da520c9..08dd3bd4 100644 --- a/Documentation/guides.xml +++ b/Documentation/guides.xml @@ -3,7 +3,6 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd" links-are-relative="true" - default-code-language="php" >