Skip to content

Commit

Permalink
[DOCS] Fix formatting for lists in .rst
Browse files Browse the repository at this point in the history
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/+/80631
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
  • Loading branch information
sypets authored and lolli42 committed Aug 23, 2023
1 parent 41ece65 commit d742e21
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 14 deletions.
Expand Up @@ -63,8 +63,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.

Expand Down
Expand Up @@ -12,8 +12,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.
Expand Down
Expand Up @@ -73,8 +73,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`
Expand Down
Expand Up @@ -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
Expand Down
Expand Up @@ -22,6 +22,7 @@ The following hooks are removed with a PSR-14 equivalent:
* :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/class.tx_cms_layout.php']['tt_content_drawItem']`

The following hooks have been removed without substitution:

* :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/class.tx_cms_layout.php']['list_type_Info']`
* :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/class.tx_cms_layout.php']['tt_content_drawFooter']`

Expand Down
Expand Up @@ -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
Expand Down
Expand Up @@ -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
Expand Down

0 comments on commit d742e21

Please sign in to comment.