diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/CommaSeparatedValueProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/CommaSeparatedValueProcessor.rst index e44f29137..d1ffae720 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/CommaSeparatedValueProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/CommaSeparatedValueProcessor.rst @@ -12,13 +12,18 @@ 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 @@ -26,10 +31,13 @@ Options: 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` @@ -40,7 +48,11 @@ Options: .. _CommaSeparatedValueProcessor-as: +as +-- + .. confval:: as + :name: CommaSeparatedValueProcessor-as :Required: false :Data type: :ref:`data-type-string` @@ -48,10 +60,13 @@ Options: 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` @@ -64,7 +79,11 @@ Options: .. _CommaSeparatedValueProcessor-fieldDelimiter: +fieldDelimiter +-------------- + .. confval:: fieldDelimiter + :name: CommaSeparatedValueProcessor-fieldDelimiter :Required: false :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -75,7 +94,11 @@ Options: .. _CommaSeparatedValueProcessor-fieldEnclosure: +fieldEnclosure +-------------- + .. confval:: fieldEnclosure + :name: CommaSeparatedValueProcessor-fieldEnclosure :Required: false :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -83,6 +106,7 @@ Options: The field enclosure, a character surrounding the values. +.. _CommaSeparatedValueProcessor-examples: Example: Transforming comma separated content into a html table =============================================================== @@ -96,7 +120,6 @@ the values can be specified. This example is also described in-depth in :ref:`TYPO3 Explained: Extended content element example `. - Example data in the field :php:`bodytext` ----------------------------------------- diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/DatabaseQueryProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/DatabaseQueryProcessor.rst index f129bf590..b1dd10714 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/DatabaseQueryProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/DatabaseQueryProcessor.rst @@ -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 @@ -29,7 +34,11 @@ Options: .. _DatabaseQueryProcessor-table: +table +----- + .. confval:: table + :name: DatabaseQueryProcessor-table :Required: true :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -39,7 +48,11 @@ Options: .. _DatabaseQueryProcessor-as: +as +-- + .. confval:: as + :name: DatabaseQueryProcessor-as :Required: false :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -49,7 +62,11 @@ Options: .. _DatabaseQueryProcessor-dataProcessing: +dataProcessing +-------------- + .. confval:: dataProcessing + :name: DatabaseQueryProcessor-dataProcessing :Required: false :Data type: array of :ref:`dataProcessing` @@ -69,6 +86,7 @@ Options: See `here `__ for more information. +.. _DatabaseQueryProcessor-examples: Example: Display haiku records ============================== diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/FilesProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/FilesProcessor.rst index c155b9ebc..dc1863752 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/FilesProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/FilesProcessor.rst @@ -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 @@ -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` @@ -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` @@ -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` @@ -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` @@ -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` @@ -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` @@ -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` @@ -142,7 +175,11 @@ Options: .. _FilesProcessor-sorting: +sorting +------- + .. confval:: sorting + :name: FilesProcessor-sorting :Required: false :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -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` @@ -167,7 +208,11 @@ Options: .. _FilesProcessor-as: +as +-- + .. confval:: as + :name: FilesProcessor-as :Required: false :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -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 ================================================== diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/FlexFormProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/FlexFormProcessor.rst index 48882adee..9b10f0598 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/FlexFormProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/FlexFormProcessor.rst @@ -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` @@ -28,7 +33,11 @@ Options .. _FlexFormProcessor-references: +references +---------- + .. confval:: references + :name: FlexFormProcessor-references .. versionadded:: 13.0 @@ -48,7 +57,11 @@ Options .. _FlexFormProcessor-as: +as +-- + .. confval:: as + :name: FlexFormProcessor-as :Required: false :Data type: :ref:`data-type-string` @@ -56,10 +69,13 @@ Options Name for the variable in the Fluid template. +.. _FlexFormProcessor-examples: Examples ======== +.. _FlexFormProcessor-example-minimal: + Example of a minimal TypoScript configuration --------------------------------------------- @@ -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 ----------------------------------------------- @@ -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 ----------------------------------- diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/GalleryProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/GalleryProcessor.rst index 631a5c1b9..a61bc8855 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/GalleryProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/GalleryProcessor.rst @@ -10,13 +10,18 @@ calculates the maximum asset size. It uses the files already present in the `processedData` array for its calculations. The :ref:`FilesProcessor` can be used to fetch the files. +.. _GalleryProcessor-options: Options: ======== .. _GalleryProcessor-if: +if +-- + .. confval:: if + :name: GalleryProcessor-if :Required: false :Data type: :ref:`if` condition @@ -27,7 +32,11 @@ Options: .. _GalleryProcessor-filesProcessedDataKey: +filesProcessedDataKey +--------------------- + .. confval:: filesProcessedDataKey + :name: GalleryProcessor-filesProcessedDataKey :Required: true :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -39,7 +48,11 @@ Options: .. _GalleryProcessor-numberOfColumns: +numberOfColumns +--------------- + .. confval:: numberOfColumns + :name: GalleryProcessor-numberOfColumns :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -52,7 +65,11 @@ Options: .. _GalleryProcessor-mediaOrientation: +mediaOrientation +---------------- + .. confval:: mediaOrientation + :name: GalleryProcessor-mediaOrientation :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -69,7 +86,11 @@ Options: .. _GalleryProcessor-maxGalleryWidth: +maxGalleryWidth +--------------- + .. confval:: maxGalleryWidth + :name: GalleryProcessor-maxGalleryWidth :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -80,7 +101,11 @@ Options: .. _GalleryProcessor-maxGalleryWidthInText: +maxGalleryWidthInText +--------------------- + .. confval:: maxGalleryWidthInText + :name: GalleryProcessor-maxGalleryWidthInText :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -91,7 +116,11 @@ Options: .. _GalleryProcessor-equalMediaHeight: .. _GalleryProcessor-equalMediaWidth: +equalMediaHeight, equalMediaWidth +--------------------------------- + .. confval:: equalMediaHeight, equalMediaWidth + :name: GalleryProcessor-equalMediaHeight :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -108,7 +137,11 @@ Options: .. _GalleryProcessor-columnSpacing: +columnSpacing +------------- + .. confval:: columnSpacing + :name: GalleryProcessor-columnSpacing :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -120,7 +153,11 @@ Options: .. _GalleryProcessor-borderEnabled: +borderEnabled +------------- + .. confval:: borderEnabled + :name: GalleryProcessor-borderEnabled :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -131,10 +168,13 @@ Options: fields `imageborder` (:guilabel:`Number of Columns`) if used with content elements. - .. _GalleryProcessor-borderWidth: +borderWidth +----------- + .. confval:: borderWidth + :name: GalleryProcessor-borderWidth :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -146,7 +186,11 @@ Options: .. _GalleryProcessor-borderPadding: +borderPadding +------------- + .. confval:: borderPadding + :name: GalleryProcessor-borderPadding :Required: false :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -158,7 +202,11 @@ Options: .. _GalleryProcessor-cropVariant: +cropVariant +----------- + .. confval:: cropVariant + :name: GalleryProcessor-cropVariant :Required: false :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -170,7 +218,11 @@ Options: .. _GalleryProcessor-as: +as +-- + .. confval:: as + :name: GalleryProcessor-as :Required: false :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -181,7 +233,11 @@ Options: .. _GalleryProcessor-dataProcessing: +dataProcessing +-------------- + .. confval:: dataProcessing + :name: GalleryProcessor-dataProcessing :Required: false :Data type: array of :ref:`dataProcessing` @@ -189,6 +245,7 @@ Options: Array of data processors to be applied to all fetched records. +.. _GalleryProcessor-example-rows-columns: Example: display images in rows and columns =========================================== diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/LanguageMenuProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/LanguageMenuProcessor.rst index 22b620d70..f59f314fb 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/LanguageMenuProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/LanguageMenuProcessor.rst @@ -18,12 +18,18 @@ assigned to the :typoscript:`FLUIDTEMPLATE` as a variable. information. +.. _LanguageMenuProcessor-options: + Options: ======== .. _LanguageMenuProcessor-if: +if +-- + .. confval:: if + :name: LanguageMenuProcessor-if :Required: false :Data type: :ref:`if` condition @@ -33,7 +39,11 @@ Options: .. _LanguageMenuProcessor-languages: +languages +--------- + .. confval:: languages + :name: LanguageMenuProcessor-languages :Required: true :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -47,7 +57,11 @@ Options: .. _LanguageMenuProcessor-addQueryString-exclude: +addQueryString.exclude +---------------------- + .. confval:: addQueryString.exclude + :name: LanguageMenuProcessor-addQueryString-exclude :Required: true :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -60,7 +74,11 @@ Options: .. _LanguageMenuProcessor-as: +as +-- + .. confval:: as + :name: LanguageMenuProcessor-as :Required: false :Data type: :ref:`data-type-string` @@ -68,6 +86,7 @@ Options: The variable name to be used in the Fluid template. +.. _LanguageMenuProcessor-example: Example: Menu of all language from site configuration ===================================================== diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/MenuProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/MenuProcessor.rst index 0e4351e95..a271f8ac3 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/MenuProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/MenuProcessor.rst @@ -21,12 +21,18 @@ Additional data processing is supported and will be applied to each record. `__ for more information. +.. _MenuProcessor-options: + Options ======= .. _MenuProcessor-levels: +levels +------ + .. confval:: levels + :name: MenuProcessor-levels :Required: true :Data type: :ref:`data-type-integer` / :ref:`stdWrap` @@ -38,7 +44,11 @@ Options .. _MenuProcessor-expandAll: +expandAll +--------- + .. confval:: expandAll + :name: MenuProcessor-expandAll :Required: true :Data type: :ref:`data-type-boolean` / :ref:`stdWrap` @@ -50,7 +60,11 @@ Options .. _MenuProcessor-includeSpacer: +includeSpacer +------------- + .. confval:: includeSpacer + :name: MenuProcessor-includeSpacer :Required: true :Data type: :ref:`data-type-boolean` / :ref:`stdWrap` @@ -62,7 +76,11 @@ Options .. _MenuProcessor-titleField: +titleField +---------- + .. confval:: titleField + :name: MenuProcessor-titleField :Required: true :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -74,7 +92,11 @@ Options .. _MenuProcessor-as: +as +-- + .. confval:: as + :name: MenuProcessor-as :Required: false :Data type: :ref:`data-type-string` @@ -85,6 +107,7 @@ Options .. hint:: Additionally, all :ref:`HMENU options ` are available. +.. _MenuProcessor-example-two-levels: Example: Two level menu of the web page ======================================= diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SiteLanguageProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SiteLanguageProcessor.rst index 990f86cc7..f69634763 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SiteLanguageProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SiteLanguageProcessor.rst @@ -10,13 +10,18 @@ SiteLanguageProcessor The :php:`SiteLanguageProcessor` fetches language-related data from the :ref:`site configuration`. +.. _SiteLanguageProcessor-options: Options ======= .. _SiteLanguageProcessor-as: +as +-- + .. confval:: as + :name: SiteLanguageProcessor-as :Required: false :Data type: :ref:`data-type-string` @@ -24,6 +29,7 @@ Options The variable name to be used in the Fluid template. +.. _SiteLanguageProcessor-example: Example: Output some data from the site language configuration ============================================================== diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SiteProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SiteProcessor.rst index 208dacae2..e5c8c8c46 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SiteProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SiteProcessor.rst @@ -9,12 +9,18 @@ The :php:`SiteProcessor` fetches data from the :ref:`site configuration `. +.. _SiteProcessor-options: + Options ======= .. _SiteProcessor-as: +as +-- + .. confval:: as + :name: SiteProcessor-as :Required: false :Data type: :ref:`data-type-string` @@ -22,6 +28,7 @@ Options The variable name to be used in the Fluid template. +.. _SiteProcessor-examples: Example: Output some data from the site configuration ===================================================== diff --git a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SplitProcessor.rst b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SplitProcessor.rst index 09e47ca52..cb1ba74c4 100644 --- a/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SplitProcessor.rst +++ b/Documentation/ContentObjects/Fluidtemplate/DataProcessing/SplitProcessor.rst @@ -9,13 +9,18 @@ The :php:`SplitProcessor` allows to split values separated with a delimiter from a single database field. The result is an array that can be iterated over. Whitespaces are automatically trimmed. +.. _splitProcessor-options: Options ======= .. _splitProcessor-if: +if +-- + .. confval:: if + :name: splitProcessor-if :Required: false :Data type: :ref:`if` condition @@ -26,7 +31,11 @@ Options .. _splitProcessor-fieldName: +fieldName +--------- + .. confval:: fieldName + :name: splitProcessor-fieldName :Required: true :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -37,7 +46,11 @@ Options .. _splitProcessor-as: +as +-- + .. confval:: as + :name: splitProcessor-as :Required: false :Data type: :ref:`data-type-string` @@ -48,7 +61,11 @@ Options .. _splitProcessor-delimiter: +delimiter +--------- + .. confval:: delimiter + :name: splitProcessor-delimiter :Required: false :Data type: :ref:`data-type-string` / :ref:`stdWrap` @@ -60,7 +77,11 @@ Options .. _splitProcessor-filterIntegers: +filterIntegers +-------------- + .. confval:: filterIntegers + :name: splitProcessor-filterIntegers :Required: false :Data type: :ref:`data-type-boolean` / :ref:`stdWrap` @@ -72,7 +93,11 @@ Options .. _splitProcessor-filterUnique: +filterUnique +------------ + .. confval:: filterUnique + :name: splitProcessor-filterUnique :Required: false :Data type: :ref:`data-type-boolean` / :ref:`stdWrap` @@ -84,7 +109,11 @@ Options .. _splitProcessor-removeEmptyEntries: +removeEmptyEntries +------------------ + .. confval:: removeEmptyEntries + :name: splitProcessor-removeEmptyEntries :Required: false :Data type: :ref:`data-type-boolean` / :ref:`stdWrap` @@ -93,6 +122,7 @@ Options If set to `1`, all empty values will be removed. +.. _splitProcessor-example-split-url: Example: Splitting a URL ========================