From 121e40d820d6ef0f71c10ce438a8f84cfc05b08b Mon Sep 17 00:00:00 2001
From: Susanne Moog <look@susi.dev>
Date: Mon, 2 Dec 2019 18:41:40 +0100
Subject: [PATCH] [TASK] Add missing documentation for 10.2 release
Some change log entries should be documented in extension manuals
or in ViewHelpers. The missing docs have been added.
Resolves: #89827
Releases: master
Change-Id: I6c76dc2d532b151275c60e85feb44f227ca80919
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/62515
Tested-by: Daniel Siepmann <coding@daniel-siepmann.de>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
Reviewed-by: Daniel Siepmann <coding@daniel-siepmann.de>
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
---
.../Widget/AutocompleteViewHelper.php | 4 +-
.../ViewHelpers/Widget/PaginateViewHelper.php | 2 +
.../Documentation/Configuration/Index.rst | 2 +-
.../Documentation/Development/Index.rst | 39 +++++++++++++++++++
.../linkvalidator/Documentation/Index.rst | 1 +
.../Documentation/Configuration/Concepts.rst | 8 ++++
6 files changed, 54 insertions(+), 2 deletions(-)
create mode 100644 typo3/sysext/linkvalidator/Documentation/Development/Index.rst
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Widget/AutocompleteViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Widget/AutocompleteViewHelper.php
index 364cbb048c3b..c5dd171d097b 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Widget/AutocompleteViewHelper.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Widget/AutocompleteViewHelper.php
@@ -34,13 +34,15 @@ use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
* Render lib object::
*
* <input type="text" id="name" />
- * <f:widget.autocomplete for="name" objects="{posts}" searchProperty="author">
+ * <f:widget.autocomplete for="name" objects="{posts}" searchProperty="author" storeSession="false">
*
* Output::
*
* <input type="text" id="name" />
*
* The input field and the required JavaScript for the Ajax communication.
+ * The storeSession attribute can be used in any widget
+ * and will prevent cookie creation / session storage for the widget.
* See Resources/Private/Templates/ViewHelpers/Widget/Autocomplete/Index.html
*/
class AutocompleteViewHelper extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Widget/PaginateViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Widget/PaginateViewHelper.php
index 9204436379ea..d366d533a903 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Widget/PaginateViewHelper.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Widget/PaginateViewHelper.php
@@ -43,6 +43,8 @@ use TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper;
* a <f:for> loop.
* </f:widget.paginate>
*
+ * The storeSession attribute can be used in any widget and will prevent cookie creation / session storage for the widget.
+ *
* Performance characteristics
* ===========================
*
diff --git a/typo3/sysext/linkvalidator/Documentation/Configuration/Index.rst b/typo3/sysext/linkvalidator/Documentation/Configuration/Index.rst
index 7518e24a041e..a5e02ad595d1 100644
--- a/typo3/sysext/linkvalidator/Documentation/Configuration/Index.rst
+++ b/typo3/sysext/linkvalidator/Documentation/Configuration/Index.rst
@@ -13,7 +13,7 @@ Configuration
-------------
You can find the standard configuration in
-:file:`EXT:linkvalidator/Configuration/TsConfig/Page/pagetsconfig.txt`.
+:file:`EXT:linkvalidator/Configuration/TsConfig/Page/pagetsconfig.tsconfig`.
This may serve as an example on how to configure the extension for
your needs.
diff --git a/typo3/sysext/linkvalidator/Documentation/Development/Index.rst b/typo3/sysext/linkvalidator/Documentation/Development/Index.rst
new file mode 100644
index 000000000000..8f95f730180e
--- /dev/null
+++ b/typo3/sysext/linkvalidator/Documentation/Development/Index.rst
@@ -0,0 +1,39 @@
+.. include:: ../Includes.txt
+
+
+.. _development:
+
+Development / Background Information
+------------------------------------
+
+In this chapter, we want to provide a bit of information on how the linkvalidator works internally.
+
+The procedure for marking the broken links in the RTE is as follow:
+
+#. RTE content is fetched from the database.
+ Before it is displayed in the edit form, RTE transformations are performed.
+#. The transformation function parses the text and detects links.
+#. For each link, a PSR-14 event (:php:`TYPO3\CMS\Core\Html\Event\BrokenLinkAnalysisEvent`) is dispatched.
+#. If a listener is attached, it may set the link as broken and will set the link as "checked".
+#. If a link is detected as broken, RTE will mark it as broken.
+
+Take a look at the :file:`Services.yaml` where the listeners for that event are registered:
+
+.. code-block:: yaml
+
+ TYPO3\CMS\Linkvalidator\EventListener\CheckBrokenRteLinkEventListener:
+ tags:
+ - name: event.listener
+ identifier: 'rte-check-link-external'
+ event: TYPO3\CMS\Core\Html\Event\BrokenLinkAnalysisEvent
+ method: 'checkExternalLink'
+ - name: event.listener
+ identifier: 'rte-check-link-to-page'
+ event: TYPO3\CMS\Core\Html\Event\BrokenLinkAnalysisEvent
+ method: 'checkPageLink'
+ - name: event.listener
+ identifier: 'rte-check-link-to-file'
+ event: TYPO3\CMS\Core\Html\Event\BrokenLinkAnalysisEvent
+ method: 'checkFileLink'
+
+File, Page and External Links are checked via these EventListeners.
diff --git a/typo3/sysext/linkvalidator/Documentation/Index.rst b/typo3/sysext/linkvalidator/Documentation/Index.rst
index 72eb73a84ab7..181bd7e3dc42 100644
--- a/typo3/sysext/linkvalidator/Documentation/Index.rst
+++ b/typo3/sysext/linkvalidator/Documentation/Index.rst
@@ -64,5 +64,6 @@ a GNU/GPL CMS/Framework available from `www.typo3.org
Configuration/Index
LargeSites/Index
NextSteps/Index
+ Development/Index
Targets
diff --git a/typo3/sysext/rte_ckeditor/Documentation/Configuration/Concepts.rst b/typo3/sysext/rte_ckeditor/Documentation/Configuration/Concepts.rst
index ac0a9185219f..4ddb5d84bf0d 100644
--- a/typo3/sysext/rte_ckeditor/Documentation/Configuration/Concepts.rst
+++ b/typo3/sysext/rte_ckeditor/Documentation/Configuration/Concepts.rst
@@ -180,6 +180,14 @@ Page TSconfig as well.
.. todo: real world example usages
+The loading order for configuration is:
+
+#. preset defined for a specific field via PageTS
+#. richtextConfiguration defined for a specific field via TCA
+#. general preset defined via PageTS
+#. default
+
+
For more examples, see :ref:`t3tsconfig:pageTsRte` in "TSconfig Reference".
--
GitLab