From 9b1715c1a15b0433f74401febc39f5d56868e1c5 Mon Sep 17 00:00:00 2001
From: linawolf <112@linawolf.de>
Date: Fri, 11 Nov 2022 16:48:36 +0000
Subject: [PATCH] [DOCS] Fix TypoScript in ViewHelper docs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Replace `:ts:` with ``:typoscript:` in
ViewHelper class comments. `:ts` does not
render properly, see for example
https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/typo3/fluid/latest/CObject.html
Resolves: #99068
Releases: main, 11.5
Change-Id: Idfac843859a5e9054e6e48f29b19616b2b956dac
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/76562
Tested-by: core-ci <typo3@b13.com>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Lina Wolf <112@linawolf.de>
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Chris Müller <typo3@krue.ml>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Lina Wolf <112@linawolf.de>
---
.../fluid/Classes/ViewHelpers/CObjectViewHelper.php | 12 ++++++------
.../Classes/ViewHelpers/Format/HtmlViewHelper.php | 2 +-
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php
index 34c28e79813c..db45fad2347c 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php
@@ -51,7 +51,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
*
* <f:cObject typoscriptObjectPath="lib.someLibObject" />
*
- * Rendered :ts:`lib.someLibObject`.
+ * Rendered :typoscript:`lib.someLibObject`.
*
* Specify cObject data & current value
* ------------------------------------
@@ -60,7 +60,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
*
* <f:cObject typoscriptObjectPath="lib.customHeader" data="{article}" currentValueKey="title" />
*
- * Rendered :ts:`lib.customHeader`. Data and current value will be available in TypoScript.
+ * Rendered :typoscript:`lib.customHeader`. Data and current value will be available in TypoScript.
*
* Inline notation
* ---------------
@@ -69,12 +69,12 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
*
* {article -> f:cObject(typoscriptObjectPath: 'lib.customHeader')}
*
- * Rendered :ts:`lib.customHeader`. Data will be available in TypoScript.
+ * Rendered :typoscript:`lib.customHeader`. Data will be available in TypoScript.
*
* Accessing the data in TypoScript
* --------------------------------
*
- * ::
+ * .. code-block:: typoscript
*
* lib.customHeader = COA
* lib.customHeader {
@@ -84,8 +84,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
* 20.current = 1
* }
*
- * When passing an object with ``{data}``, the properties of the object are accessible with :ts:`.field` in
- * TypoScript. If only a single value is passed or the ``currentValueKey`` is specified, :ts:`.current = 1`
+ * When passing an object with ``{data}``, the properties of the object are accessible with :typoscript:`.field` in
+ * TypoScript. If only a single value is passed or the ``currentValueKey`` is specified, :typoscript:`.current = 1`
* can be used in the TypoScript.
*/
final class CObjectViewHelper extends AbstractViewHelper
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlViewHelper.php
index 30c2d0162a20..02983e639df9 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlViewHelper.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlViewHelper.php
@@ -32,7 +32,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
/**
* Renders a string by passing it to a TYPO3 `parseFunc`_.
* You can either specify a path to the TypoScript setting or set the `parseFunc`_ options directly.
- * By default :ts:`lib.parseFunc_RTE` is used to parse the string.
+ * By default :typoscript:`lib.parseFunc_RTE` is used to parse the string.
*
* Examples
* ========
--
GitLab