Skip to content

Commit

Permalink
[TASK] Set unique names for confvals in Dataprocessor chapter (#1144)
Browse files Browse the repository at this point in the history
* [TASK] Set unique names for confvals in Dataprocesso chapter

Add missing anchors and headlines

releases: main, 12.4

* Update Documentation/ContentObjects/Fluidtemplate/DataProcessing/FilesProcessor.rst

Co-authored-by: Chris Müller <[email protected]>

* Update Documentation/ContentObjects/Fluidtemplate/DataProcessing/FlexFormProcessor.rst

Co-authored-by: Chris Müller <[email protected]>

* Update Documentation/ContentObjects/Fluidtemplate/DataProcessing/LanguageMenuProcessor.rst

Co-authored-by: Chris Müller <[email protected]>

---------

Co-authored-by: Chris Müller <[email protected]>
  • Loading branch information
linawolf and brotkrueml authored Mar 25, 2024
1 parent 0d8deff commit ad5a372
Show file tree
Hide file tree
Showing 10 changed files with 254 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,32 @@ two-dimensional array used for :abbr:`CSV (Comma-separated values)` files or
The table data is transformed to a multi-dimensional array, taking the delimiter
and enclosure into account, before it is passed to the view.

.. _CommaSeparatedValueProcessor-options:

Options:
========

.. _CommaSeparatedValueProcessor-if:

if
--

.. confval:: if
:name: CommaSeparatedValueProcessor-if

:Required: false
:Data type: :ref:`if` condition
:default: ''

If the condition is met, the data processor is processed.


.. _CommaSeparatedValueProcessor-fieldName:

fieldName
---------

.. confval:: fieldName
:name: CommaSeparatedValueProcessor-fieldName

:Required: true
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -40,18 +48,25 @@ Options:

.. _CommaSeparatedValueProcessor-as:

as
--

.. confval:: as
:name: CommaSeparatedValueProcessor-as

:Required: false
:Data type: :ref:`data-type-string`
:default: defaults to the fieldName

The variable's name to be used in the Fluid template.


.. _CommaSeparatedValueProcessor-maximumColumns:

maximumColumns
--------------

.. confval:: maximumColumns
:name: CommaSeparatedValueProcessor-maximumColumns

:Required: false
:Data type: :ref:`data-type-integer` / :ref:`stdWrap`
Expand All @@ -64,7 +79,11 @@ Options:

.. _CommaSeparatedValueProcessor-fieldDelimiter:

fieldDelimiter
--------------

.. confval:: fieldDelimiter
:name: CommaSeparatedValueProcessor-fieldDelimiter

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -75,14 +94,19 @@ Options:

.. _CommaSeparatedValueProcessor-fieldEnclosure:

fieldEnclosure
--------------

.. confval:: fieldEnclosure
:name: CommaSeparatedValueProcessor-fieldEnclosure

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
:default: :typoscript:`"`

The field enclosure, a character surrounding the values.

.. _CommaSeparatedValueProcessor-examples:

Example: Transforming comma separated content into a html table
===============================================================
Expand All @@ -96,7 +120,6 @@ the values can be specified.
This example is also described in-depth in :ref:`TYPO3 Explained:
Extended content element example <t3coreapi:AddingCE-Extended-Example>`.


Example data in the field :php:`bodytext`
-----------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,18 @@ standard TypoScript :ref:`select` semantics. The result is then passed to the
This way a :ref:`cobj-fluidtemplate` cObject can iterate over the
array of records.

.. _DatabaseQueryProcessor-options:

Options:
========

.. _DatabaseQueryProcessor-if:

if
--

.. confval:: if
:name: DatabaseQueryProcessor-if

:Required: false
:Data type: :ref:`if` condition
Expand All @@ -29,7 +34,11 @@ Options:

.. _DatabaseQueryProcessor-table:

table
-----

.. confval:: table
:name: DatabaseQueryProcessor-table

:Required: true
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -39,7 +48,11 @@ Options:

.. _DatabaseQueryProcessor-as:

as
--

.. confval:: as
:name: DatabaseQueryProcessor-as

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -49,7 +62,11 @@ Options:

.. _DatabaseQueryProcessor-dataProcessing:

dataProcessing
--------------

.. confval:: dataProcessing
:name: DatabaseQueryProcessor-dataProcessing

:Required: false
:Data type: array of :ref:`dataProcessing`
Expand All @@ -69,6 +86,7 @@ Options:
See `here <https://forge.typo3.org/issues/85284#note-5>`__ for more
information.

.. _DatabaseQueryProcessor-examples:

Example: Display haiku records
==============================
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,18 @@ This data processor can be used for processing file information:
A :typoscript:`FLUIDTEMPLATE` can then iterate over processed data
automatically.

.. _FilesProcessor-options:

Options:
========

.. _FilesProcessor-if:

if
--

.. confval:: if
:name: FilesProcessor-if

:Required: false
:Data type: :ref:`if` condition
Expand All @@ -32,7 +37,11 @@ Options:

.. _FilesProcessor-references:

references
----------

.. confval:: references
:name: FilesProcessor-references

:Required: false
:Data type: :ref:`data-type-string` (comma-separated integers) / :ref:`stdWrap`
Expand All @@ -50,7 +59,11 @@ Options:

.. _FilesProcessor-references-fieldName:

references.fieldName
~~~~~~~~~~~~~~~~~~~~

.. confval:: references.fieldName
:name: FilesProcessor-references-fieldName

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -65,7 +78,11 @@ Options:

.. _FilesProcessor-references-table:

references.table
~~~~~~~~~~~~~~~~

.. confval:: references.table
:name: FilesProcessor-references.table

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -79,7 +96,11 @@ Options:

.. _FilesProcessor-files:

files
-----

.. confval:: files
:name: FilesProcessor-files

:Required: false
:Data type: :ref:`data-type-string` (comma-separated integers) / :ref:`stdWrap`
Expand All @@ -92,7 +113,11 @@ Options:

.. _FilesProcessor-collections:

collections
-----------

.. confval:: collections
:name: FilesProcessor-collections

:Required: false
:Data type: :ref:`data-type-string` (comma-separated integers) / :ref:`stdWrap`
Expand All @@ -106,7 +131,11 @@ Options:

.. _FilesProcessor-folders:

folders
-------

.. confval:: folders
:name: FilesProcessor-folders

:Required: false
:Data type: :ref:`data-type-string` (comma-separated folders), :ref:`stdWrap`
Expand All @@ -129,7 +158,11 @@ Options:

.. _FilesProcessor-folders-recursive:

folders.recursive
~~~~~~~~~~~~~~~~~

.. confval:: folders.recursive
:name: FilesProcessor-folders-recursive

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -142,7 +175,11 @@ Options:

.. _FilesProcessor-sorting:

sorting
-------

.. confval:: sorting
:name: FilesProcessor-sorting

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -155,7 +192,11 @@ Options:

.. _FilesProcessor-sorting-direction:

sorting.direction
~~~~~~~~~~~~~~~~~

.. confval:: sorting.direction
:name: FilesProcessor-sorting-direction

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -167,7 +208,11 @@ Options:

.. _FilesProcessor-as:

as
--

.. confval:: as
:name: FilesProcessor-as

:Required: false
:Data type: :ref:`data-type-string` / :ref:`stdWrap`
Expand All @@ -176,6 +221,8 @@ Options:
The variable name to be used in the Fluid template.


.. _FilesProcessor-example-render-image:

Example 1: Render the images stored in field image
==================================================

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,18 @@ data within an XML structure inside a single database column. The data processor
:php:`\TYPO3\CMS\Frontend\DataProcessing\FlexFormProcessor` converts the
FlexForm data of a given field into a Fluid-readable array.

.. _FlexFormProcessor-options:

Options
=======

.. _FlexFormProcessor-fieldname:

fieldname
---------

.. confval:: fieldname
:name: FlexFormProcessor-fieldname

:Required: false
:Data type: :ref:`data-type-string`
Expand All @@ -28,7 +33,11 @@ Options

.. _FlexFormProcessor-references:

references
----------

.. confval:: references
:name: FlexFormProcessor-references

.. versionadded:: 13.0

Expand All @@ -48,18 +57,25 @@ Options

.. _FlexFormProcessor-as:

as
--

.. confval:: as
:name: FlexFormProcessor-as

:Required: false
:Data type: :ref:`data-type-string`
:default: 'flexFormData'

Name for the variable in the Fluid template.

.. _FlexFormProcessor-examples:

Examples
========

.. _FlexFormProcessor-example-minimal:

Example of a minimal TypoScript configuration
---------------------------------------------

Expand All @@ -79,6 +95,8 @@ Example of a minimal TypoScript configuration
The converted array can be accessed within the Fluid template with the
:html:`{flexFormData}` variable.

.. _FlexFormProcessor-example-advanced:

Example of an advanced TypoScript configuration
-----------------------------------------------

Expand All @@ -97,6 +115,8 @@ Example of an advanced TypoScript configuration
The converted array can be accessed within the Fluid template with the
:html:`{myOutputVariable}` variable.

.. _FlexFormProcessor-example-sub-processor:

Example with a custom sub-processor
-----------------------------------

Expand Down
Loading

0 comments on commit ad5a372

Please sign in to comment.