From c813459fd72e87de5056383cc95605145e3cbe8b Mon Sep 17 00:00:00 2001
From: Sybille Peters <sypets@gmx.de>
Date: Sun, 20 Aug 2023 10:09:46 +0200
Subject: [PATCH] [DOCS] Fix formatting for lists in .rst
If there is not a newline before and after the list, the list
may not be formatted correctly.
A newline was added before and after lists in .rst files.
Additionally, some lines beginning with "- " (which would result
in false positives when checking) were modified so that list checking
can be performed more easily in the future.
Lists can be checked for example by using the following regular
expressions:
find typo3/sysext/*/Documentation -name "*.rst" | while read i;do
grep -B1 -H -E "^(\-|\*)\s" "$i" | grep "\.rst-" \
| grep -v -E "\.rst-($|\-|\*|\s)"
grep -A1 -H -E "^(\-|\*)\s" "$i" | grep "\.rst-" \
| grep -v -E "\.rst-($|\-|\*|\s)"
done
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ \
WritingReST/CommonPitfalls/Lists.html
Resolves: #101715
Releases: main, 12.4, 11.5
Change-Id: I8dca5634ae3dcd7e702197cb72b43d79a05f3f5c
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80652
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: core-ci <typo3@b13.com>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
---
...92655-MakeRequestTimeoutConfigurableForLinkvalidator.rst | 4 ++--
...eprecation-94377-ExtbaseObjectManager-getEmptyObject.rst | 4 ++--
.../Changelog/11.4/Feature-94622-NewTCATypeCategory.rst | 4 ++--
...-100889-AllowInsecureSiteResolutionByQueryParameters.rst | 6 +++---
.../Documentation/AnalysingIndexedData/Index.rst | 4 ++--
5 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/typo3/sysext/core/Documentation/Changelog/10.4.x/Important-92655-MakeRequestTimeoutConfigurableForLinkvalidator.rst b/typo3/sysext/core/Documentation/Changelog/10.4.x/Important-92655-MakeRequestTimeoutConfigurableForLinkvalidator.rst
index 67a8cebf8eb9..1453ce6676c8 100644
--- a/typo3/sysext/core/Documentation/Changelog/10.4.x/Important-92655-MakeRequestTimeoutConfigurableForLinkvalidator.rst
+++ b/typo3/sysext/core/Documentation/Changelog/10.4.x/Important-92655-MakeRequestTimeoutConfigurableForLinkvalidator.rst
@@ -61,8 +61,8 @@ Depending on the library used and the tool, you can usually set:
* read timeout
* general timeout
-Libraries and utilities often have these options separately, including
-- for example - the curl command line tool or Guzzle.
+Libraries and utilities often have these options separately, including - for
+example - the curl command line tool or Guzzle.
TYPO3 uses Guzzle under the hood.
diff --git a/typo3/sysext/core/Documentation/Changelog/11.3/Deprecation-94377-ExtbaseObjectManager-getEmptyObject.rst b/typo3/sysext/core/Documentation/Changelog/11.3/Deprecation-94377-ExtbaseObjectManager-getEmptyObject.rst
index 567aa43b3b82..faf1adac4c3a 100644
--- a/typo3/sysext/core/Documentation/Changelog/11.3/Deprecation-94377-ExtbaseObjectManager-getEmptyObject.rst
+++ b/typo3/sysext/core/Documentation/Changelog/11.3/Deprecation-94377-ExtbaseObjectManager-getEmptyObject.rst
@@ -10,8 +10,8 @@ Description
===========
Extbase has the odd behavior that
-:php:`\TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface` objects
-- typically classes in :file:`Classes/Domain/Model` of Extbase enabled
+:php:`\TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface` objects -
+typically classes in :file:`Classes/Domain/Model` of Extbase enabled
extensions - don't call :php:`__construct` when the persistence layer
"thaws" a model from database - typically when a Extbase
:php:`Domain/Repository` uses a :php:`->findBy*` method.
diff --git a/typo3/sysext/core/Documentation/Changelog/11.4/Feature-94622-NewTCATypeCategory.rst b/typo3/sysext/core/Documentation/Changelog/11.4/Feature-94622-NewTCATypeCategory.rst
index d482b4616845..3624417855a9 100644
--- a/typo3/sysext/core/Documentation/Changelog/11.4/Feature-94622-NewTCATypeCategory.rst
+++ b/typo3/sysext/core/Documentation/Changelog/11.4/Feature-94622-NewTCATypeCategory.rst
@@ -71,8 +71,8 @@ It's possible to use TSconfig options, such as
implemented for this type. For such special cases, please continue using TCA
type :php:`select`.
-The Override matrix - specifying the options which can be overridden in TSconfig
-- is extended for the new type. Following options can be overridden:
+The Override matrix - specifying the options which can be overridden in
+TSconfig - is extended for the new type. Following options can be overridden:
* :php:`size`
* :php:`maxitems`
diff --git a/typo3/sysext/core/Documentation/Changelog/11.5.x/Important-100889-AllowInsecureSiteResolutionByQueryParameters.rst b/typo3/sysext/core/Documentation/Changelog/11.5.x/Important-100889-AllowInsecureSiteResolutionByQueryParameters.rst
index ff5f1217f763..aa47a3ccea4b 100644
--- a/typo3/sysext/core/Documentation/Changelog/11.5.x/Important-100889-AllowInsecureSiteResolutionByQueryParameters.rst
+++ b/typo3/sysext/core/Documentation/Changelog/11.5.x/Important-100889-AllowInsecureSiteResolutionByQueryParameters.rst
@@ -20,9 +20,9 @@ default. However, it is still allowed to resolve a particular page by, for
example, "example.org" - as long as the page ID `123` is in the scope of the
site configured for the base URL "example.org".
-The new feature flag `security.frontend.allowInsecureSiteResolutionByQueryParameters`
-- which is disabled per default - can be used to reactivate the previous
-behavior:
+The new feature flag
+`security.frontend.allowInsecureSiteResolutionByQueryParameters` - which is
+disabled per default - can be used to reactivate the previous behavior:
.. code-block:: php
diff --git a/typo3/sysext/indexed_search/Documentation/AnalysingIndexedData/Index.rst b/typo3/sysext/indexed_search/Documentation/AnalysingIndexedData/Index.rst
index 94177c287d99..074b079ae548 100644
--- a/typo3/sysext/indexed_search/Documentation/AnalysingIndexedData/Index.rst
+++ b/typo3/sysext/indexed_search/Documentation/AnalysingIndexedData/Index.rst
@@ -184,8 +184,8 @@ As you see the main board page showing the list of messages/threads
("Sourcream and Oni...") is indexed without any values for the
parameter tt\_board\_uid (static_page_arguments). Then it has
also been indexed one time for each display of a message. In a search
-result any of these five rows may appear as an independent result row
-- after all they are to be regarded as a single page with unique
+result any of these five rows may appear as an independent result row - after
+all they are to be regarded as a single page with unique
content, despite sharing the same page-id!
Another interesting thing is that while the main page has inherited
--
GitLab