Skip to content

[TASK] Suggest to use <f:render.text> for records #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
linawolf merged 1 commit into from
Mar 23, 2026
Merged

[TASK] Suggest to use <f:render.text> for records #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions Documentation/Global/Format/Html.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@
Format.html ViewHelper `<f:format.html>`
========================================

.. versionchanged:: 14.0

The `Render.text ViewHelper <f:render.text> <https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-render-text>`_
should be used whenever text fields from records are
displayed in HTML output.

Depending on the TCA definition of the rendered field `nl2br` is then
automatically applied for multi line text areas.

.. typo3:viewhelper:: format.html
:source: ../../Global.json
:display: tags,description,gitHubLink
Expand Down Expand Up @@ -81,26 +90,38 @@ With a custom parsing function defined in TypoScript:
.. _typo3-fluid-format-html-arguments-data:

Data argument
--------------
-------------

.. versionchanged:: 14.0

The `Render.text ViewHelper <f:render.text> <https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-render-text>`_
should be used whenever text fields from records are
displayed in HTML output.

Depending on the TCA definition of the rendered field `nl2br` is then
automatically applied for multi line text areas.

If you use TypoScript properties such as :typoscript:`field` or :typoscript:`dataWrap`,
you should pass the current record as `data`. This ensures that field references like
you should pass structured data
(`Data transfer object (DTO) <https://docs.typo3.org/permalink/t3coreapi:extbase-dto>`_
or named array) as `data`. This ensures that field references like
`{FIELD:title}` are resolved correctly.

.. code-block:: html

<f:format.html
data="{newsRecord}"
data="{someDto}"
parseFuncTSPath="lib.myParseFunc"
>
News title:
You entered the following in the form:
</f:format.html>

You may get the following output:

.. code-block:: html

News title: <strong>TYPO3, greatest CMS ever</strong>
You entered the following in the form:
<strong>TYPO3, greatest CMS ever</strong>

With a custom parsing function defined in TypoScript:

Expand Down Expand Up @@ -156,7 +177,7 @@ current value.
.. code-block:: html

<f:format.html
data="{contentRecord}"
data="{someDto}"
currentValueKey="header"
parseFuncTSPath="lib.content"
>
Expand Down
9 changes: 9 additions & 0 deletions Documentation/Global/Format/Nl2br.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@
Format.nl2br ViewHelper `<f:format.nl2br>`
==========================================

.. versionchanged:: 14.0

The `Render.text ViewHelper <f:render.text> <https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-render-text>`_
should be used whenever text fields from records are
displayed in HTML output.

Depending on the TCA definition of the rendered field `nl2br` is then
automatically applied for multi line text areas.

.. typo3:viewhelper:: format.nl2br
:source: ../../Global.json
:display: tags,description,gitHubLink
Expand Down