diff --git a/Documentation/typo3/backend/latest/Avatar.rst b/Documentation/typo3/backend/latest/Avatar.rst index 9938b87..9465a2c 100644 --- a/Documentation/typo3/backend/latest/Avatar.rst +++ b/Documentation/typo3/backend/latest/Avatar.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/AvatarViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/AvatarViewHelper.php :navigation-title: avatar .. include:: /Includes.rst.txt .. _typo3-backend-avatar: ==================================== -avatar ViewHelper `` +Avatar ViewHelper `` ==================================== - Render the avatar markup, including the :html:`` tag, for a given backend user. Examples @@ -45,51 +48,57 @@ Output:: +.. _typo3-backend-avatar_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `AvatarViewHelper.php (GitHub) `__. .. _typo3-backend-avatar_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-backend-avatar-backenduser: +.. contents:: + :local: + + +.. _typo3-backend-avatar-backenduser_argument: backendUser ----------- -:aspect:`DataType` - mixed +.. confval:: backendUser + :name: typo3-backend-avatar-backenduser + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Uid of the backend user + Uid of the backend user -.. _typo3-backend-avatar-size: +.. _typo3-backend-avatar-size_argument: size ---- -:aspect:`DataType` - mixed - -:aspect:`Default` - 32 +.. confval:: size + :name: typo3-backend-avatar-size + :type: mixed + :Default: 32 + :required: false -:aspect:`Required` - false -:aspect:`Description` - Width and height of the image + Width and height of the image -.. _typo3-backend-avatar-showicon: +.. _typo3-backend-avatar-showicon_argument: showIcon -------- -:aspect:`DataType` - boolean +.. confval:: showIcon + :name: typo3-backend-avatar-showicon + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Show the record icon as well + Show the record icon as well diff --git a/Documentation/typo3/backend/latest/LanguageColumn.rst b/Documentation/typo3/backend/latest/LanguageColumn.rst index 78fb273..1ea1735 100644 --- a/Documentation/typo3/backend/latest/LanguageColumn.rst +++ b/Documentation/typo3/backend/latest/LanguageColumn.rst @@ -1,44 +1,56 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/LanguageColumnViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/LanguageColumnViewHelper.php :navigation-title: languageColumn .. include:: /Includes.rst.txt .. _typo3-backend-languagecolumn: ==================================================== -languageColumn ViewHelper `` +LanguageColumn ViewHelper `` ==================================================== +.. _typo3-backend-languagecolumn_source: + +Source code +=========== +Go to the source code of this ViewHelper: `LanguageColumnViewHelper.php (GitHub) `__. .. _typo3-backend-languagecolumn_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-backend-languagecolumn-languagecolumn: +.. _typo3-backend-languagecolumn-languagecolumn_argument: languageColumn -------------- -:aspect:`DataType` - mixed +.. confval:: languageColumn + :name: typo3-backend-languagecolumn-languagecolumn + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Language column object which is context for column + Language column object which is context for column -.. _typo3-backend-languagecolumn-columnnumber: +.. _typo3-backend-languagecolumn-columnnumber_argument: columnNumber ------------ -:aspect:`DataType` - mixed +.. confval:: columnNumber + :name: typo3-backend-languagecolumn-columnnumber + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Number (colPos) of column within LanguageColumn to be returned + Number (colPos) of column within LanguageColumn to be returned diff --git a/Documentation/typo3/backend/latest/Link/EditRecord.rst b/Documentation/typo3/backend/latest/Link/EditRecord.rst index 24fa33a..b1b8a2c 100644 --- a/Documentation/typo3/backend/latest/Link/EditRecord.rst +++ b/Documentation/typo3/backend/latest/Link/EditRecord.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/Link/EditRecordViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/Link/EditRecordViewHelper.php :navigation-title: link.editRecord .. include:: /Includes.rst.txt .. _typo3-backend-link-editrecord: ====================================================== -link.editRecord ViewHelper `` +Link.editRecord ViewHelper `` ====================================================== - Use this ViewHelper to provide edit links to records. The ViewHelper will pass the uid and table to FormEngine. @@ -43,217 +46,212 @@ Output:: Edit record +.. _typo3-backend-link-editrecord_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `EditRecordViewHelper.php (GitHub) `__. .. _typo3-backend-link-editrecord_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-backend-link-editrecord-additionalattributes: +.. _typo3-backend-link-editrecord-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-backend-link-editrecord-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-backend-link-editrecord-data: +.. _typo3-backend-link-editrecord-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-backend-link-editrecord-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-backend-link-editrecord-aria: +.. _typo3-backend-link-editrecord-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-backend-link-editrecord-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-backend-link-editrecord-class: +.. _typo3-backend-link-editrecord-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-backend-link-editrecord-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-backend-link-editrecord-dir: +.. _typo3-backend-link-editrecord-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-backend-link-editrecord-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-backend-link-editrecord-id: +.. _typo3-backend-link-editrecord-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-backend-link-editrecord-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-backend-link-editrecord-lang: +.. _typo3-backend-link-editrecord-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-backend-link-editrecord-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-backend-link-editrecord-style: +.. _typo3-backend-link-editrecord-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-backend-link-editrecord-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-backend-link-editrecord-title: +.. _typo3-backend-link-editrecord-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-backend-link-editrecord-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-backend-link-editrecord-accesskey: +.. _typo3-backend-link-editrecord-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-backend-link-editrecord-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-backend-link-editrecord-tabindex: +.. _typo3-backend-link-editrecord-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-backend-link-editrecord-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-backend-link-editrecord-onclick: +.. _typo3-backend-link-editrecord-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-backend-link-editrecord-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-backend-link-editrecord-uid: +.. _typo3-backend-link-editrecord-uid_argument: uid --- -:aspect:`DataType` - mixed +.. confval:: uid + :name: typo3-backend-link-editrecord-uid + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Uid of record to be edited + Uid of record to be edited -.. _typo3-backend-link-editrecord-table: +.. _typo3-backend-link-editrecord-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-backend-link-editrecord-table + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Target database table + Target database table -.. _typo3-backend-link-editrecord-fields: +.. _typo3-backend-link-editrecord-fields_argument: fields ------ -:aspect:`DataType` - string +.. confval:: fields + :name: typo3-backend-link-editrecord-fields + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Edit only these fields (comma separated list) + Edit only these fields (comma separated list) -.. _typo3-backend-link-editrecord-returnurl: +.. _typo3-backend-link-editrecord-returnurl_argument: returnUrl --------- -:aspect:`DataType` - string +.. confval:: returnUrl + :name: typo3-backend-link-editrecord-returnurl + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Return to this URL after closing the edit dialog + Return to this URL after closing the edit dialog diff --git a/Documentation/typo3/backend/latest/Link/NewRecord.rst b/Documentation/typo3/backend/latest/Link/NewRecord.rst index 3b58c24..eb9d3e9 100644 --- a/Documentation/typo3/backend/latest/Link/NewRecord.rst +++ b/Documentation/typo3/backend/latest/Link/NewRecord.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/Link/NewRecordViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/Link/NewRecordViewHelper.php :navigation-title: link.newRecord .. include:: /Includes.rst.txt .. _typo3-backend-link-newrecord: ==================================================== -link.newRecord ViewHelper `` +Link.newRecord ViewHelper `` ==================================================== - Use this ViewHelper to provide 'create new record' links. The ViewHelper will pass the command to FormEngine. @@ -79,233 +82,225 @@ Output:: New record +.. _typo3-backend-link-newrecord_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `NewRecordViewHelper.php (GitHub) `__. .. _typo3-backend-link-newrecord_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-backend-link-newrecord-additionalattributes: +.. contents:: + :local: + + +.. _typo3-backend-link-newrecord-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-backend-link-newrecord-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-backend-link-newrecord-data: +.. _typo3-backend-link-newrecord-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-backend-link-newrecord-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-backend-link-newrecord-aria: +.. _typo3-backend-link-newrecord-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-backend-link-newrecord-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-backend-link-newrecord-class: +.. _typo3-backend-link-newrecord-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-backend-link-newrecord-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-backend-link-newrecord-dir: +.. _typo3-backend-link-newrecord-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-backend-link-newrecord-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-backend-link-newrecord-id: +.. _typo3-backend-link-newrecord-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-backend-link-newrecord-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-backend-link-newrecord-lang: +.. _typo3-backend-link-newrecord-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-backend-link-newrecord-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-backend-link-newrecord-style: +.. _typo3-backend-link-newrecord-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-backend-link-newrecord-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-backend-link-newrecord-title: +.. _typo3-backend-link-newrecord-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-backend-link-newrecord-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-backend-link-newrecord-accesskey: +.. _typo3-backend-link-newrecord-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-backend-link-newrecord-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-backend-link-newrecord-tabindex: +.. _typo3-backend-link-newrecord-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-backend-link-newrecord-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-backend-link-newrecord-onclick: +.. _typo3-backend-link-newrecord-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-backend-link-newrecord-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-backend-link-newrecord-uid: +.. _typo3-backend-link-newrecord-uid_argument: uid --- -:aspect:`DataType` - mixed +.. confval:: uid + :name: typo3-backend-link-newrecord-uid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Uid < 0 will insert the record after the given uid + Uid < 0 will insert the record after the given uid -.. _typo3-backend-link-newrecord-pid: +.. _typo3-backend-link-newrecord-pid_argument: pid --- -:aspect:`DataType` - mixed +.. confval:: pid + :name: typo3-backend-link-newrecord-pid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The page id where the record will be created + The page id where the record will be created -.. _typo3-backend-link-newrecord-table: +.. _typo3-backend-link-newrecord-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-backend-link-newrecord-table + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Target database table + Target database table -.. _typo3-backend-link-newrecord-returnurl: +.. _typo3-backend-link-newrecord-returnurl_argument: returnUrl --------- -:aspect:`DataType` - string +.. confval:: returnUrl + :name: typo3-backend-link-newrecord-returnurl + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Return to this URL after closing the new record dialog + Return to this URL after closing the new record dialog -.. _typo3-backend-link-newrecord-defaultvalues: +.. _typo3-backend-link-newrecord-defaultvalues_argument: defaultValues ------------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: defaultValues + :name: typo3-backend-link-newrecord-defaultvalues + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Default values for fields of the new record + Default values for fields of the new record diff --git a/Documentation/typo3/backend/latest/Mfa/IfHasState.rst b/Documentation/typo3/backend/latest/Mfa/IfHasState.rst index b0a2d49..7698b3e 100644 --- a/Documentation/typo3/backend/latest/Mfa/IfHasState.rst +++ b/Documentation/typo3/backend/latest/Mfa/IfHasState.rst @@ -1,70 +1,80 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/Mfa/IfHasStateViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/Mfa/IfHasStateViewHelper.php :navigation-title: mfa.ifHasState .. include:: /Includes.rst.txt .. _typo3-backend-mfa-ifhasstate: ==================================================== -mfa.ifHasState ViewHelper `` +Mfa.ifHasState ViewHelper `` ==================================================== - Check if the given provider for the current user has the requested state set +.. _typo3-backend-mfa-ifhasstate_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IfHasStateViewHelper.php (GitHub) `__. .. _typo3-backend-mfa-ifhasstate_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-backend-mfa-ifhasstate-then: +.. _typo3-backend-mfa-ifhasstate-then_argument: then ---- -:aspect:`DataType` - mixed +.. confval:: then + :name: typo3-backend-mfa-ifhasstate-then + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if met. + Value to be returned if the condition if met. -.. _typo3-backend-mfa-ifhasstate-else: +.. _typo3-backend-mfa-ifhasstate-else_argument: else ---- -:aspect:`DataType` - mixed +.. confval:: else + :name: typo3-backend-mfa-ifhasstate-else + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if not met. + Value to be returned if the condition if not met. -.. _typo3-backend-mfa-ifhasstate-state: +.. _typo3-backend-mfa-ifhasstate-state_argument: state ----- -:aspect:`DataType` - string +.. confval:: state + :name: typo3-backend-mfa-ifhasstate-state + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The state to check for (e.g. active or locked) + The state to check for (e.g. active or locked) -.. _typo3-backend-mfa-ifhasstate-provider: +.. _typo3-backend-mfa-ifhasstate-provider_argument: provider -------- -:aspect:`DataType` - mixed +.. confval:: provider + :name: typo3-backend-mfa-ifhasstate-provider + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - The provider in question + The provider in question diff --git a/Documentation/typo3/backend/latest/ModuleLink.rst b/Documentation/typo3/backend/latest/ModuleLink.rst index 3acf063..f65eb41 100644 --- a/Documentation/typo3/backend/latest/ModuleLink.rst +++ b/Documentation/typo3/backend/latest/ModuleLink.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/ModuleLinkViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/ModuleLinkViewHelper.php :navigation-title: moduleLink .. include:: /Includes.rst.txt .. _typo3-backend-modulelink: ============================================ -moduleLink ViewHelper `` +ModuleLink ViewHelper `` ============================================ - Create internal link within backend. Examples @@ -25,64 +28,69 @@ Output:: +.. _typo3-backend-modulelink_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ModuleLinkViewHelper.php (GitHub) `__. .. _typo3-backend-modulelink_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-backend-modulelink-route: +.. contents:: + :local: + + +.. _typo3-backend-modulelink-route_argument: route ----- -:aspect:`DataType` - string +.. confval:: route + :name: typo3-backend-modulelink-route + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The route to link to + The route to link to -.. _typo3-backend-modulelink-arguments: +.. _typo3-backend-modulelink-arguments_argument: arguments --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: arguments + :name: typo3-backend-modulelink-arguments + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional link arguments + Additional link arguments -.. _typo3-backend-modulelink-query: +.. _typo3-backend-modulelink-query_argument: query ----- -:aspect:`DataType` - string +.. confval:: query + :name: typo3-backend-modulelink-query + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional link arguments as string + Additional link arguments as string -.. _typo3-backend-modulelink-currenturlparametername: +.. _typo3-backend-modulelink-currenturlparametername_argument: currentUrlParameterName ----------------------- -:aspect:`DataType` - string +.. confval:: currentUrlParameterName + :name: typo3-backend-modulelink-currenturlparametername + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Add current url as given parameter + Add current url as given parameter diff --git a/Documentation/typo3/backend/latest/Thumbnail.rst b/Documentation/typo3/backend/latest/Thumbnail.rst index 236d055..3090c99 100644 --- a/Documentation/typo3/backend/latest/Thumbnail.rst +++ b/Documentation/typo3/backend/latest/Thumbnail.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/ThumbnailViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/ThumbnailViewHelper.php :navigation-title: thumbnail .. include:: /Includes.rst.txt .. _typo3-backend-thumbnail: ========================================== -thumbnail ViewHelper `` +Thumbnail ViewHelper `` ========================================== - ViewHelper for the backend which generates an :html:`` tag with the special URI to render thumbnails deferred. Examples @@ -43,418 +46,394 @@ Output:: alt="alt set in image record" title="title set in image record"/> +.. _typo3-backend-thumbnail_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ThumbnailViewHelper.php (GitHub) `__. .. _typo3-backend-thumbnail_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-backend-thumbnail-additionalattributes: +.. contents:: + :local: + + +.. _typo3-backend-thumbnail-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-backend-thumbnail-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-backend-thumbnail-data: +.. _typo3-backend-thumbnail-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-backend-thumbnail-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-backend-thumbnail-aria: +.. _typo3-backend-thumbnail-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-backend-thumbnail-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-backend-thumbnail-class: +.. _typo3-backend-thumbnail-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-backend-thumbnail-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-backend-thumbnail-dir: +.. _typo3-backend-thumbnail-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-backend-thumbnail-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-backend-thumbnail-id: +.. _typo3-backend-thumbnail-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-backend-thumbnail-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-backend-thumbnail-lang: +.. _typo3-backend-thumbnail-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-backend-thumbnail-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-backend-thumbnail-style: +.. _typo3-backend-thumbnail-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-backend-thumbnail-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-backend-thumbnail-title: +.. _typo3-backend-thumbnail-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-backend-thumbnail-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-backend-thumbnail-accesskey: +.. _typo3-backend-thumbnail-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-backend-thumbnail-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-backend-thumbnail-tabindex: +.. _typo3-backend-thumbnail-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-backend-thumbnail-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-backend-thumbnail-onclick: +.. _typo3-backend-thumbnail-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-backend-thumbnail-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-backend-thumbnail-alt: +.. _typo3-backend-thumbnail-alt_argument: alt --- -:aspect:`DataType` - string +.. confval:: alt + :name: typo3-backend-thumbnail-alt + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies an alternate text for an image + Specifies an alternate text for an image -.. _typo3-backend-thumbnail-ismap: +.. _typo3-backend-thumbnail-ismap_argument: ismap ----- -:aspect:`DataType` - string +.. confval:: ismap + :name: typo3-backend-thumbnail-ismap + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies an image as a server-side image-map. Rarely used. Look at usemap instead + Specifies an image as a server-side image-map. Rarely used. Look at usemap instead -.. _typo3-backend-thumbnail-usemap: +.. _typo3-backend-thumbnail-usemap_argument: usemap ------ -:aspect:`DataType` - string +.. confval:: usemap + :name: typo3-backend-thumbnail-usemap + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies an image as a client-side image-map + Specifies an image as a client-side image-map -.. _typo3-backend-thumbnail-loading: +.. _typo3-backend-thumbnail-loading_argument: loading ------- -:aspect:`DataType` - string +.. confval:: loading + :name: typo3-backend-thumbnail-loading + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Native lazy-loading for images property. Can be "lazy", "eager" or "auto" + Native lazy-loading for images property. Can be "lazy", "eager" or "auto" -.. _typo3-backend-thumbnail-decoding: +.. _typo3-backend-thumbnail-decoding_argument: decoding -------- -:aspect:`DataType` - string +.. confval:: decoding + :name: typo3-backend-thumbnail-decoding + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Provides an image decoding hint to the browser. Can be "sync", "async" or "auto" + Provides an image decoding hint to the browser. Can be "sync", "async" or "auto" -.. _typo3-backend-thumbnail-src: +.. _typo3-backend-thumbnail-src_argument: src --- -:aspect:`DataType` - string +.. confval:: src + :name: typo3-backend-thumbnail-src + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - A path to a file, a combined FAL identifier or an uid (int). If $treatIdAsReference is set, the integer is considered the uid of the sys_file_reference record. If you already got a FAL object, consider using the $image parameter instead + A path to a file, a combined FAL identifier or an uid (int). If $treatIdAsReference is set, the integer is considered the uid of the sys_file_reference record. If you already got a FAL object, consider using the $image parameter instead -.. _typo3-backend-thumbnail-treatidasreference: +.. _typo3-backend-thumbnail-treatidasreference_argument: treatIdAsReference ------------------ -:aspect:`DataType` - boolean +.. confval:: treatIdAsReference + :name: typo3-backend-thumbnail-treatidasreference + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Given src argument is a sys_file_reference record + Given src argument is a sys_file_reference record -.. _typo3-backend-thumbnail-image: +.. _typo3-backend-thumbnail-image_argument: image ----- -:aspect:`DataType` - mixed +.. confval:: image + :name: typo3-backend-thumbnail-image + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - A FAL object (\TYPO3\CMS\Core\Resource\File or \TYPO3\CMS\Core\Resource\FileReference) + A FAL object (\TYPO3\CMS\Core\Resource\File or \TYPO3\CMS\Core\Resource\FileReference) -.. _typo3-backend-thumbnail-crop: +.. _typo3-backend-thumbnail-crop_argument: crop ---- -:aspect:`DataType` - mixed +.. confval:: crop + :name: typo3-backend-thumbnail-crop + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Overrule cropping of image (setting to FALSE disables the cropping set in FileReference) + Overrule cropping of image (setting to FALSE disables the cropping set in FileReference) -.. _typo3-backend-thumbnail-cropvariant: +.. _typo3-backend-thumbnail-cropvariant_argument: cropVariant ----------- -:aspect:`DataType` - string +.. confval:: cropVariant + :name: typo3-backend-thumbnail-cropvariant + :type: string + :Default: 'default' + :required: false -:aspect:`Default` - 'default' + Select a cropping variant, in case multiple croppings have been specified or stored in FileReference -:aspect:`Required` - false -:aspect:`Description` - Select a cropping variant, in case multiple croppings have been specified or stored in FileReference - -.. _typo3-backend-thumbnail-fileextension: +.. _typo3-backend-thumbnail-fileextension_argument: fileExtension ------------- -:aspect:`DataType` - string +.. confval:: fileExtension + :name: typo3-backend-thumbnail-fileextension + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Custom file extension to use + Custom file extension to use -.. _typo3-backend-thumbnail-width: +.. _typo3-backend-thumbnail-width_argument: width ----- -:aspect:`DataType` - string +.. confval:: width + :name: typo3-backend-thumbnail-width + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. + Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. -.. _typo3-backend-thumbnail-height: +.. _typo3-backend-thumbnail-height_argument: height ------ -:aspect:`DataType` - string +.. confval:: height + :name: typo3-backend-thumbnail-height + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. + Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. -.. _typo3-backend-thumbnail-minwidth: +.. _typo3-backend-thumbnail-minwidth_argument: minWidth -------- -:aspect:`DataType` - mixed +.. confval:: minWidth + :name: typo3-backend-thumbnail-minwidth + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Minimum width of the image + Minimum width of the image -.. _typo3-backend-thumbnail-minheight: +.. _typo3-backend-thumbnail-minheight_argument: minHeight --------- -:aspect:`DataType` - mixed +.. confval:: minHeight + :name: typo3-backend-thumbnail-minheight + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Minimum height of the image + Minimum height of the image -.. _typo3-backend-thumbnail-maxwidth: +.. _typo3-backend-thumbnail-maxwidth_argument: maxWidth -------- -:aspect:`DataType` - mixed +.. confval:: maxWidth + :name: typo3-backend-thumbnail-maxwidth + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Maximum width of the image + Maximum width of the image -.. _typo3-backend-thumbnail-maxheight: +.. _typo3-backend-thumbnail-maxheight_argument: maxHeight --------- -:aspect:`DataType` - mixed +.. confval:: maxHeight + :name: typo3-backend-thumbnail-maxheight + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Maximum height of the image + Maximum height of the image -.. _typo3-backend-thumbnail-absolute: +.. _typo3-backend-thumbnail-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-backend-thumbnail-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Force absolute URL + Force absolute URL -.. _typo3-backend-thumbnail-context: +.. _typo3-backend-thumbnail-context_argument: context ------- -:aspect:`DataType` - string - -:aspect:`Default` - 'Image.Preview' +.. confval:: context + :name: typo3-backend-thumbnail-context + :type: string + :Default: 'Image.Preview' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Context for image rendering + Context for image rendering diff --git a/Documentation/typo3/backend/latest/Toolbar/Attributes.rst b/Documentation/typo3/backend/latest/Toolbar/Attributes.rst index e9a537e..78ab8bc 100644 --- a/Documentation/typo3/backend/latest/Toolbar/Attributes.rst +++ b/Documentation/typo3/backend/latest/Toolbar/Attributes.rst @@ -1,31 +1,44 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/Toolbar/AttributesViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/Toolbar/AttributesViewHelper.php :navigation-title: toolbar.attributes .. include:: /Includes.rst.txt .. _typo3-backend-toolbar-attributes: ============================================================ -toolbar.attributes ViewHelper `` +Toolbar.attributes ViewHelper `` ============================================================ - Builds an attribute string for use in rendered toolbar items +.. _typo3-backend-toolbar-attributes_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `AttributesViewHelper.php (GitHub) `__. .. _typo3-backend-toolbar-attributes_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-backend-toolbar-attributes-class: +.. _typo3-backend-toolbar-attributes-class_argument: class ----- -:aspect:`DataType` - mixed +.. confval:: class + :name: typo3-backend-toolbar-attributes-class + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Class being converted to a string for usage as id attribute + Class being converted to a string for usage as id attribute diff --git a/Documentation/typo3/backend/latest/Toolbar/IfHasDropdown.rst b/Documentation/typo3/backend/latest/Toolbar/IfHasDropdown.rst index d4a76a8..29c848f 100644 --- a/Documentation/typo3/backend/latest/Toolbar/IfHasDropdown.rst +++ b/Documentation/typo3/backend/latest/Toolbar/IfHasDropdown.rst @@ -1,57 +1,68 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/Toolbar/IfHasDropdownViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/Toolbar/IfHasDropdownViewHelper.php :navigation-title: toolbar.ifHasDropdown .. include:: /Includes.rst.txt .. _typo3-backend-toolbar-ifhasdropdown: ================================================================== -toolbar.ifHasDropdown ViewHelper `` +Toolbar.ifHasDropdown ViewHelper `` ================================================================== - Checks whether a toolbar item provides a dropdown menu +.. _typo3-backend-toolbar-ifhasdropdown_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IfHasDropdownViewHelper.php (GitHub) `__. .. _typo3-backend-toolbar-ifhasdropdown_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-backend-toolbar-ifhasdropdown-then: +.. _typo3-backend-toolbar-ifhasdropdown-then_argument: then ---- -:aspect:`DataType` - mixed +.. confval:: then + :name: typo3-backend-toolbar-ifhasdropdown-then + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if met. + Value to be returned if the condition if met. -.. _typo3-backend-toolbar-ifhasdropdown-else: +.. _typo3-backend-toolbar-ifhasdropdown-else_argument: else ---- -:aspect:`DataType` - mixed +.. confval:: else + :name: typo3-backend-toolbar-ifhasdropdown-else + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if not met. + Value to be returned if the condition if not met. -.. _typo3-backend-toolbar-ifhasdropdown-class: +.. _typo3-backend-toolbar-ifhasdropdown-class_argument: class ----- -:aspect:`DataType` - mixed +.. confval:: class + :name: typo3-backend-toolbar-ifhasdropdown-class + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - The toolbar item class to be checked for providing a drop down + The toolbar item class to be checked for providing a drop down diff --git a/Documentation/typo3/backend/latest/TypoScript/FineDiff.rst b/Documentation/typo3/backend/latest/TypoScript/FineDiff.rst index 06474d8..daffddd 100644 --- a/Documentation/typo3/backend/latest/TypoScript/FineDiff.rst +++ b/Documentation/typo3/backend/latest/TypoScript/FineDiff.rst @@ -1,44 +1,56 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/TypoScript/FineDiffViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/TypoScript/FineDiffViewHelper.php :navigation-title: typoScript.fineDiff .. include:: /Includes.rst.txt .. _typo3-backend-typoscript-finediff: ============================================================== -typoScript.fineDiff ViewHelper `` +TypoScript.fineDiff ViewHelper `` ============================================================== - Runs two strings through 'FineDiff' on word level. +.. _typo3-backend-typoscript-finediff_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `FineDiffViewHelper.php (GitHub) `__. .. _typo3-backend-typoscript-finediff_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-backend-typoscript-finediff-from: +.. _typo3-backend-typoscript-finediff-from_argument: from ---- -:aspect:`DataType` - string +.. confval:: from + :name: typo3-backend-typoscript-finediff-from + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Source string + Source string -.. _typo3-backend-typoscript-finediff-to: +.. _typo3-backend-typoscript-finediff-to_argument: to -- -:aspect:`DataType` - string +.. confval:: to + :name: typo3-backend-typoscript-finediff-to + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Target string + Target string diff --git a/Documentation/typo3/backend/latest/Uri/EditRecord.rst b/Documentation/typo3/backend/latest/Uri/EditRecord.rst index 910dcff..bd96473 100644 --- a/Documentation/typo3/backend/latest/Uri/EditRecord.rst +++ b/Documentation/typo3/backend/latest/Uri/EditRecord.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/Uri/EditRecordViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/Uri/EditRecordViewHelper.php :navigation-title: uri.editRecord .. include:: /Includes.rst.txt .. _typo3-backend-uri-editrecord: ==================================================== -uri.editRecord ViewHelper `` +Uri.editRecord ViewHelper `` ==================================================== - Use this ViewHelper to provide edit links (only the uri) to records. The ViewHelper will pass the uid and table to FormEngine. @@ -30,61 +33,68 @@ page uid=42 and return to foo/bar:: ```` +.. _typo3-backend-uri-editrecord_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `EditRecordViewHelper.php (GitHub) `__. .. _typo3-backend-uri-editrecord_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-backend-uri-editrecord-uid: +.. _typo3-backend-uri-editrecord-uid_argument: uid --- -:aspect:`DataType` - mixed +.. confval:: uid + :name: typo3-backend-uri-editrecord-uid + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Uid of record to be edited, 0 for creation + Uid of record to be edited, 0 for creation -.. _typo3-backend-uri-editrecord-table: +.. _typo3-backend-uri-editrecord-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-backend-uri-editrecord-table + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Target database table + Target database table -.. _typo3-backend-uri-editrecord-fields: +.. _typo3-backend-uri-editrecord-fields_argument: fields ------ -:aspect:`DataType` - string +.. confval:: fields + :name: typo3-backend-uri-editrecord-fields + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Edit only these fields (comma separated list) + Edit only these fields (comma separated list) -.. _typo3-backend-uri-editrecord-returnurl: +.. _typo3-backend-uri-editrecord-returnurl_argument: returnUrl --------- -:aspect:`DataType` - string +.. confval:: returnUrl + :name: typo3-backend-uri-editrecord-returnurl + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Return to this URL after closing the edit dialog + Return to this URL after closing the edit dialog diff --git a/Documentation/typo3/backend/latest/Uri/NewRecord.rst b/Documentation/typo3/backend/latest/Uri/NewRecord.rst index b9f5f46..94a98fd 100644 --- a/Documentation/typo3/backend/latest/Uri/NewRecord.rst +++ b/Documentation/typo3/backend/latest/Uri/NewRecord.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/backend/Classes/ViewHelpers/Uri/NewRecordViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/backend/Classes/ViewHelpers/Uri/NewRecordViewHelper.php :navigation-title: uri.newRecord .. include:: /Includes.rst.txt .. _typo3-backend-uri-newrecord: ================================================== -uri.newRecord ViewHelper `` +Uri.newRecord ViewHelper `` ================================================== - Use this ViewHelper to provide 'create new record' links. The ViewHelper will pass the command to FormEngine. @@ -53,77 +56,81 @@ Uri to create a new record of a_table on page 17 with a default value:: ``/typo3/record/edit?edit[a_table][17]=new&returnUrl=foo/bar&defVals[a_table][a_field]=value`` +.. _typo3-backend-uri-newrecord_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `NewRecordViewHelper.php (GitHub) `__. .. _typo3-backend-uri-newrecord_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-backend-uri-newrecord-uid: +.. contents:: + :local: + + +.. _typo3-backend-uri-newrecord-uid_argument: uid --- -:aspect:`DataType` - mixed +.. confval:: uid + :name: typo3-backend-uri-newrecord-uid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Uid < 0 will insert the record after the given uid + Uid < 0 will insert the record after the given uid -.. _typo3-backend-uri-newrecord-pid: +.. _typo3-backend-uri-newrecord-pid_argument: pid --- -:aspect:`DataType` - mixed +.. confval:: pid + :name: typo3-backend-uri-newrecord-pid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The page id where the record will be created + The page id where the record will be created -.. _typo3-backend-uri-newrecord-table: +.. _typo3-backend-uri-newrecord-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-backend-uri-newrecord-table + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Target database table + Target database table -.. _typo3-backend-uri-newrecord-returnurl: +.. _typo3-backend-uri-newrecord-returnurl_argument: returnUrl --------- -:aspect:`DataType` - string +.. confval:: returnUrl + :name: typo3-backend-uri-newrecord-returnurl + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Return to this URL after closing the edit dialog + Return to this URL after closing the edit dialog -.. _typo3-backend-uri-newrecord-defaultvalues: +.. _typo3-backend-uri-newrecord-defaultvalues_argument: defaultValues ------------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: defaultValues + :name: typo3-backend-uri-newrecord-defaultvalues + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Default values for fields of the new record + Default values for fields of the new record diff --git a/Documentation/typo3/core/latest/Icon.rst b/Documentation/typo3/core/latest/Icon.rst index ba38909..e64d3b0 100644 --- a/Documentation/typo3/core/latest/Icon.rst +++ b/Documentation/typo3/core/latest/Icon.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/core/Classes/ViewHelpers/IconViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/core/Classes/ViewHelpers/IconViewHelper.php :navigation-title: icon .. include:: /Includes.rst.txt .. _typo3-core-icon: ============================= -icon ViewHelper `` +Icon ViewHelper `` ============================= - Displays icon identified by icon identifier. Examples @@ -37,93 +40,94 @@ Output:: +.. _typo3-core-icon_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IconViewHelper.php (GitHub) `__. .. _typo3-core-icon_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-core-icon-identifier: +.. contents:: + :local: + + +.. _typo3-core-icon-identifier_argument: identifier ---------- -:aspect:`DataType` - string +.. confval:: identifier + :name: typo3-core-icon-identifier + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Identifier of the icon as registered in the Icon Registry. + Identifier of the icon as registered in the Icon Registry. -.. _typo3-core-icon-size: +.. _typo3-core-icon-size_argument: size ---- -:aspect:`DataType` - string +.. confval:: size + :name: typo3-core-icon-size + :type: string + :Default: 'small' + :required: false -:aspect:`Default` - 'small' + Desired size of the icon. All values of the Icons.sizes enum are allowed, these are: "small", "default", "large" and "overlay". -:aspect:`Required` - false -:aspect:`Description` - Desired size of the icon. All values of the Icons.sizes enum are allowed, these are: "small", "default", "large" and "overlay". - -.. _typo3-core-icon-overlay: +.. _typo3-core-icon-overlay_argument: overlay ------- -:aspect:`DataType` - string +.. confval:: overlay + :name: typo3-core-icon-overlay + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Identifier of an overlay icon as registered in the Icon Registry. + Identifier of an overlay icon as registered in the Icon Registry. -.. _typo3-core-icon-state: +.. _typo3-core-icon-state_argument: state ----- -:aspect:`DataType` - string - -:aspect:`Default` - 'default' +.. confval:: state + :name: typo3-core-icon-state + :type: string + :Default: 'default' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Sets the state of the icon. All values of the Icons.states enum are allowed, these are: "default" and "disabled". + Sets the state of the icon. All values of the Icons.states enum are allowed, these are: "default" and "disabled". -.. _typo3-core-icon-alternativemarkupidentifier: +.. _typo3-core-icon-alternativemarkupidentifier_argument: alternativeMarkupIdentifier --------------------------- -:aspect:`DataType` - string +.. confval:: alternativeMarkupIdentifier + :name: typo3-core-icon-alternativemarkupidentifier + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Alternative icon identifier. Takes precedence over the identifier if supported by the IconProvider. + Alternative icon identifier. Takes precedence over the identifier if supported by the IconProvider. -.. _typo3-core-icon-title: +.. _typo3-core-icon-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-core-icon-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Title for the icon + Title for the icon diff --git a/Documentation/typo3/core/latest/IconForRecord.rst b/Documentation/typo3/core/latest/IconForRecord.rst index 3542bcb..b64ed06 100644 --- a/Documentation/typo3/core/latest/IconForRecord.rst +++ b/Documentation/typo3/core/latest/IconForRecord.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/core/Classes/ViewHelpers/IconForRecordViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/core/Classes/ViewHelpers/IconForRecordViewHelper.php :navigation-title: iconForRecord .. include:: /Includes.rst.txt .. _typo3-core-iconforrecord: =============================================== -iconForRecord ViewHelper `` +IconForRecord ViewHelper `` =============================================== - Displays icon for record. Examples @@ -25,64 +28,69 @@ Output:: +.. _typo3-core-iconforrecord_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IconForRecordViewHelper.php (GitHub) `__. .. _typo3-core-iconforrecord_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-core-iconforrecord-table: +.. contents:: + :local: + + +.. _typo3-core-iconforrecord-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-core-iconforrecord-table + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The table for the record icon + The table for the record icon -.. _typo3-core-iconforrecord-row: +.. _typo3-core-iconforrecord-row_argument: row --- -:aspect:`DataType` - mixed +.. confval:: row + :name: typo3-core-iconforrecord-row + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - The record row + The record row -.. _typo3-core-iconforrecord-size: +.. _typo3-core-iconforrecord-size_argument: size ---- -:aspect:`DataType` - string - -:aspect:`Default` - 'small' +.. confval:: size + :name: typo3-core-iconforrecord-size + :type: string + :Default: 'small' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The icon size + The icon size -.. _typo3-core-iconforrecord-alternativemarkupidentifier: +.. _typo3-core-iconforrecord-alternativemarkupidentifier_argument: alternativeMarkupIdentifier --------------------------- -:aspect:`DataType` - string +.. confval:: alternativeMarkupIdentifier + :name: typo3-core-iconforrecord-alternativemarkupidentifier + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Alternative markup identifier + Alternative markup identifier diff --git a/Documentation/typo3/core/latest/IconForResource.rst b/Documentation/typo3/core/latest/IconForResource.rst index f50c960..341573c 100644 --- a/Documentation/typo3/core/latest/IconForResource.rst +++ b/Documentation/typo3/core/latest/IconForResource.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/core/Classes/ViewHelpers/IconForResourceViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/core/Classes/ViewHelpers/IconForResourceViewHelper.php :navigation-title: iconForResource .. include:: /Includes.rst.txt .. _typo3-core-iconforresource: =================================================== -iconForResource ViewHelper `` +IconForResource ViewHelper `` =================================================== - Displays icon for a FAL resource (file or folder means a :php:`TYPO3\CMS\Core\Resource\ResourceInterface`). Examples @@ -25,80 +28,82 @@ Output:: +.. _typo3-core-iconforresource_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IconForResourceViewHelper.php (GitHub) `__. .. _typo3-core-iconforresource_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-core-iconforresource-resource: +.. contents:: + :local: + + +.. _typo3-core-iconforresource-resource_argument: resource -------- -:aspect:`DataType` - mixed +.. confval:: resource + :name: typo3-core-iconforresource-resource + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Resource + Resource -.. _typo3-core-iconforresource-size: +.. _typo3-core-iconforresource-size_argument: size ---- -:aspect:`DataType` - string +.. confval:: size + :name: typo3-core-iconforresource-size + :type: string + :Default: 'small' + :required: false -:aspect:`Default` - 'small' + The icon size -:aspect:`Required` - false -:aspect:`Description` - The icon size - -.. _typo3-core-iconforresource-overlay: +.. _typo3-core-iconforresource-overlay_argument: overlay ------- -:aspect:`DataType` - string +.. confval:: overlay + :name: typo3-core-iconforresource-overlay + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Overlay identifier + Overlay identifier -.. _typo3-core-iconforresource-options: +.. _typo3-core-iconforresource-options_argument: options ------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: options + :name: typo3-core-iconforresource-options + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - An associative array with additional options + An associative array with additional options -.. _typo3-core-iconforresource-alternativemarkupidentifier: +.. _typo3-core-iconforresource-alternativemarkupidentifier_argument: alternativeMarkupIdentifier --------------------------- -:aspect:`DataType` - string +.. confval:: alternativeMarkupIdentifier + :name: typo3-core-iconforresource-alternativemarkupidentifier + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Alternative markup identifier + Alternative markup identifier diff --git a/Documentation/typo3/core/latest/NormalizedUrl.rst b/Documentation/typo3/core/latest/NormalizedUrl.rst index 52f0e55..583a1c5 100644 --- a/Documentation/typo3/core/latest/NormalizedUrl.rst +++ b/Documentation/typo3/core/latest/NormalizedUrl.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/core/Classes/ViewHelpers/NormalizedUrlViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/core/Classes/ViewHelpers/NormalizedUrlViewHelper.php :navigation-title: normalizedUrl .. include:: /Includes.rst.txt .. _typo3-core-normalizedurl: =============================================== -normalizedUrl ViewHelper `` +NormalizedUrl ViewHelper `` =============================================== - Normalizes a path that uses EXT: syntax or an absolute URL to an absolute web path Examples @@ -29,22 +32,32 @@ Output:: /typo3/sysext/core/Resources/Public/Images/typo3_black.svg +.. _typo3-core-normalizedurl_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `NormalizedUrlViewHelper.php (GitHub) `__. .. _typo3-core-normalizedurl_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-core-normalizedurl-pathorurl: +.. _typo3-core-normalizedurl-pathorurl_argument: pathOrUrl --------- -:aspect:`DataType` - string +.. confval:: pathOrUrl + :name: typo3-core-normalizedurl-pathorurl + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Absolute path to file using EXT: syntax or URL. + Absolute path to file using EXT: syntax or URL. diff --git a/Documentation/typo3/fluid/latest/Asset/Css.rst b/Documentation/typo3/fluid/latest/Asset/Css.rst index 22c5236..f9839d0 100644 --- a/Documentation/typo3/fluid/latest/Asset/Css.rst +++ b/Documentation/typo3/fluid/latest/Asset/Css.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Asset/CssViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Asset/CssViewHelper.php :navigation-title: asset.css .. include:: /Includes.rst.txt .. _typo3-fluid-asset-css: ==================================== -asset.css ViewHelper `` +Asset.css ViewHelper `` ==================================== - ViewHelper to add CSS to the TYPO3 AssetCollector. Either a file or inline CSS can be added. Examples @@ -30,373 +33,356 @@ Some available attributes are defaults but do not make sense for this ViewHelper for this ViewHelper are: as, crossorigin, disabled, href, hreflang, importance, integrity, media, referrerpolicy, sizes, type, nonce. +.. _typo3-fluid-asset-css_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CssViewHelper.php (GitHub) `__. .. _typo3-fluid-asset-css_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-asset-css-additionalattributes: +.. _typo3-fluid-asset-css-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-asset-css-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-asset-css-data: +.. _typo3-fluid-asset-css-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-asset-css-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-asset-css-aria: +.. _typo3-fluid-asset-css-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-asset-css-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-asset-css-class: +.. _typo3-fluid-asset-css-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-asset-css-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-asset-css-dir: +.. _typo3-fluid-asset-css-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-asset-css-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-asset-css-id: +.. _typo3-fluid-asset-css-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-asset-css-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-asset-css-lang: +.. _typo3-fluid-asset-css-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-asset-css-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-asset-css-style: +.. _typo3-fluid-asset-css-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-asset-css-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-asset-css-title: +.. _typo3-fluid-asset-css-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-asset-css-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-asset-css-accesskey: +.. _typo3-fluid-asset-css-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-asset-css-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-asset-css-tabindex: +.. _typo3-fluid-asset-css-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-asset-css-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-asset-css-onclick: +.. _typo3-fluid-asset-css-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-asset-css-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-asset-css-as: +.. _typo3-fluid-asset-css-as_argument: as -- -:aspect:`DataType` - string +.. confval:: as + :name: typo3-fluid-asset-css-as + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the type of content being loaded (For rel="preload" or rel="prefetch" only). + Define the type of content being loaded (For rel="preload" or rel="prefetch" only). -.. _typo3-fluid-asset-css-crossorigin: +.. _typo3-fluid-asset-css-crossorigin_argument: crossorigin ----------- -:aspect:`DataType` - string +.. confval:: crossorigin + :name: typo3-fluid-asset-css-crossorigin + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define how to handle crossorigin requests. + Define how to handle crossorigin requests. -.. _typo3-fluid-asset-css-disabled: +.. _typo3-fluid-asset-css-disabled_argument: disabled -------- -:aspect:`DataType` - boolean +.. confval:: disabled + :name: typo3-fluid-asset-css-disabled + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define whether or not the described stylesheet should be loaded and applied to the document. + Define whether or not the described stylesheet should be loaded and applied to the document. -.. _typo3-fluid-asset-css-href: +.. _typo3-fluid-asset-css-href_argument: href ---- -:aspect:`DataType` - string +.. confval:: href + :name: typo3-fluid-asset-css-href + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the URL of the resource (absolute or relative). + Define the URL of the resource (absolute or relative). -.. _typo3-fluid-asset-css-hreflang: +.. _typo3-fluid-asset-css-hreflang_argument: hreflang -------- -:aspect:`DataType` - string +.. confval:: hreflang + :name: typo3-fluid-asset-css-hreflang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the language of the resource (Only to be used if 'href' is set). + Define the language of the resource (Only to be used if 'href' is set). -.. _typo3-fluid-asset-css-importance: +.. _typo3-fluid-asset-css-importance_argument: importance ---------- -:aspect:`DataType` - string +.. confval:: importance + :name: typo3-fluid-asset-css-importance + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the relative fetch priority of the resource. + Define the relative fetch priority of the resource. -.. _typo3-fluid-asset-css-integrity: +.. _typo3-fluid-asset-css-integrity_argument: integrity --------- -:aspect:`DataType` - string +.. confval:: integrity + :name: typo3-fluid-asset-css-integrity + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define base64-encoded cryptographic hash of the resource that allows browsers to verify what they fetch. + Define base64-encoded cryptographic hash of the resource that allows browsers to verify what they fetch. -.. _typo3-fluid-asset-css-media: +.. _typo3-fluid-asset-css-media_argument: media ----- -:aspect:`DataType` - string +.. confval:: media + :name: typo3-fluid-asset-css-media + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define which media type the resources applies to. + Define which media type the resources applies to. -.. _typo3-fluid-asset-css-referrerpolicy: +.. _typo3-fluid-asset-css-referrerpolicy_argument: referrerpolicy -------------- -:aspect:`DataType` - string +.. confval:: referrerpolicy + :name: typo3-fluid-asset-css-referrerpolicy + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define which referrer is sent when fetching the resource. + Define which referrer is sent when fetching the resource. -.. _typo3-fluid-asset-css-rel: +.. _typo3-fluid-asset-css-rel_argument: rel --- -:aspect:`DataType` - string +.. confval:: rel + :name: typo3-fluid-asset-css-rel + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the relationship of the target object to the link object. + Define the relationship of the target object to the link object. -.. _typo3-fluid-asset-css-sizes: +.. _typo3-fluid-asset-css-sizes_argument: sizes ----- -:aspect:`DataType` - string +.. confval:: sizes + :name: typo3-fluid-asset-css-sizes + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the icon size of the resource. + Define the icon size of the resource. -.. _typo3-fluid-asset-css-type: +.. _typo3-fluid-asset-css-type_argument: type ---- -:aspect:`DataType` - string +.. confval:: type + :name: typo3-fluid-asset-css-type + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the MIME type (usually 'text/css'). + Define the MIME type (usually 'text/css'). -.. _typo3-fluid-asset-css-nonce: +.. _typo3-fluid-asset-css-nonce_argument: nonce ----- -:aspect:`DataType` - string +.. confval:: nonce + :name: typo3-fluid-asset-css-nonce + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define a cryptographic nonce (number used once) used to whitelist inline styles in a style-src Content-Security-Policy. + Define a cryptographic nonce (number used once) used to whitelist inline styles in a style-src Content-Security-Policy. -.. _typo3-fluid-asset-css-usenonce: +.. _typo3-fluid-asset-css-usenonce_argument: useNonce -------- -:aspect:`DataType` - boolean +.. confval:: useNonce + :name: typo3-fluid-asset-css-usenonce + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Whether to use the global nonce value + Whether to use the global nonce value -.. _typo3-fluid-asset-css-identifier: +.. _typo3-fluid-asset-css-identifier_argument: identifier ---------- -:aspect:`DataType` - string +.. confval:: identifier + :name: typo3-fluid-asset-css-identifier + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Use this identifier within templates to only inject your CSS once, even though it is added multiple times. + Use this identifier within templates to only inject your CSS once, even though it is added multiple times. -.. _typo3-fluid-asset-css-priority: +.. _typo3-fluid-asset-css-priority_argument: priority -------- -:aspect:`DataType` - boolean +.. confval:: priority + :name: typo3-fluid-asset-css-priority + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define whether the CSS should be included before other CSS. CSS will always be output in the tag. + Define whether the CSS should be included before other CSS. CSS will always be output in the tag. diff --git a/Documentation/typo3/fluid/latest/Asset/Script.rst b/Documentation/typo3/fluid/latest/Asset/Script.rst index 2aea81e..3fe5908 100644 --- a/Documentation/typo3/fluid/latest/Asset/Script.rst +++ b/Documentation/typo3/fluid/latest/Asset/Script.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Asset/ScriptViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Asset/ScriptViewHelper.php :navigation-title: asset.script .. include:: /Includes.rst.txt .. _typo3-fluid-asset-script: ========================================== -asset.script ViewHelper `` +Asset.script ViewHelper `` ========================================== - ViewHelper to add JavaScript to the TYPO3 AssetCollector. Either a file or inline JavaScript can be added. Examples @@ -29,321 +32,308 @@ times using the same identifier, the asset will only be served once (the last ad Some available attributes are defaults but do not make sense for this ViewHelper. Relevant attributes specific for this ViewHelper are: async, crossorigin, defer, integrity, nomodule, nonce, referrerpolicy, src, type. +.. _typo3-fluid-asset-script_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ScriptViewHelper.php (GitHub) `__. .. _typo3-fluid-asset-script_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-asset-script-additionalattributes: +.. _typo3-fluid-asset-script-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-asset-script-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-asset-script-data: +.. _typo3-fluid-asset-script-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-asset-script-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-asset-script-aria: +.. _typo3-fluid-asset-script-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-asset-script-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-asset-script-class: +.. _typo3-fluid-asset-script-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-asset-script-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-asset-script-dir: +.. _typo3-fluid-asset-script-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-asset-script-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-asset-script-id: +.. _typo3-fluid-asset-script-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-asset-script-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-asset-script-lang: +.. _typo3-fluid-asset-script-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-asset-script-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-asset-script-style: +.. _typo3-fluid-asset-script-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-asset-script-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-asset-script-title: +.. _typo3-fluid-asset-script-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-asset-script-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-asset-script-accesskey: +.. _typo3-fluid-asset-script-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-asset-script-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-asset-script-tabindex: +.. _typo3-fluid-asset-script-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-asset-script-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-asset-script-onclick: +.. _typo3-fluid-asset-script-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-asset-script-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-asset-script-async: +.. _typo3-fluid-asset-script-async_argument: async ----- -:aspect:`DataType` - boolean +.. confval:: async + :name: typo3-fluid-asset-script-async + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define that the script will be fetched in parallel to parsing and evaluation. + Define that the script will be fetched in parallel to parsing and evaluation. -.. _typo3-fluid-asset-script-crossorigin: +.. _typo3-fluid-asset-script-crossorigin_argument: crossorigin ----------- -:aspect:`DataType` - string +.. confval:: crossorigin + :name: typo3-fluid-asset-script-crossorigin + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define how to handle crossorigin requests. + Define how to handle crossorigin requests. -.. _typo3-fluid-asset-script-defer: +.. _typo3-fluid-asset-script-defer_argument: defer ----- -:aspect:`DataType` - boolean +.. confval:: defer + :name: typo3-fluid-asset-script-defer + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define that the script is meant to be executed after the document has been parsed. + Define that the script is meant to be executed after the document has been parsed. -.. _typo3-fluid-asset-script-integrity: +.. _typo3-fluid-asset-script-integrity_argument: integrity --------- -:aspect:`DataType` - string +.. confval:: integrity + :name: typo3-fluid-asset-script-integrity + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define base64-encoded cryptographic hash of the resource that allows browsers to verify what they fetch. + Define base64-encoded cryptographic hash of the resource that allows browsers to verify what they fetch. -.. _typo3-fluid-asset-script-nomodule: +.. _typo3-fluid-asset-script-nomodule_argument: nomodule -------- -:aspect:`DataType` - boolean +.. confval:: nomodule + :name: typo3-fluid-asset-script-nomodule + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define that the script should not be executed in browsers that support ES2015 modules. + Define that the script should not be executed in browsers that support ES2015 modules. -.. _typo3-fluid-asset-script-nonce: +.. _typo3-fluid-asset-script-nonce_argument: nonce ----- -:aspect:`DataType` - string +.. confval:: nonce + :name: typo3-fluid-asset-script-nonce + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define a cryptographic nonce (number used once) used to whitelist inline styles in a style-src Content-Security-Policy. + Define a cryptographic nonce (number used once) used to whitelist inline styles in a style-src Content-Security-Policy. -.. _typo3-fluid-asset-script-referrerpolicy: +.. _typo3-fluid-asset-script-referrerpolicy_argument: referrerpolicy -------------- -:aspect:`DataType` - string +.. confval:: referrerpolicy + :name: typo3-fluid-asset-script-referrerpolicy + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define which referrer is sent when fetching the resource. + Define which referrer is sent when fetching the resource. -.. _typo3-fluid-asset-script-src: +.. _typo3-fluid-asset-script-src_argument: src --- -:aspect:`DataType` - string +.. confval:: src + :name: typo3-fluid-asset-script-src + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the URI of the external resource. + Define the URI of the external resource. -.. _typo3-fluid-asset-script-type: +.. _typo3-fluid-asset-script-type_argument: type ---- -:aspect:`DataType` - string +.. confval:: type + :name: typo3-fluid-asset-script-type + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the MIME type (usually 'text/javascript'). + Define the MIME type (usually 'text/javascript'). -.. _typo3-fluid-asset-script-usenonce: +.. _typo3-fluid-asset-script-usenonce_argument: useNonce -------- -:aspect:`DataType` - boolean +.. confval:: useNonce + :name: typo3-fluid-asset-script-usenonce + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Whether to use the global nonce value + Whether to use the global nonce value -.. _typo3-fluid-asset-script-identifier: +.. _typo3-fluid-asset-script-identifier_argument: identifier ---------- -:aspect:`DataType` - string +.. confval:: identifier + :name: typo3-fluid-asset-script-identifier + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Use this identifier within templates to only inject your JS once, even though it is added multiple times. + Use this identifier within templates to only inject your JS once, even though it is added multiple times. -.. _typo3-fluid-asset-script-priority: +.. _typo3-fluid-asset-script-priority_argument: priority -------- -:aspect:`DataType` - boolean +.. confval:: priority + :name: typo3-fluid-asset-script-priority + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define whether the JavaScript should be put in the tag above-the-fold or somewhere in the body part. + Define whether the JavaScript should be put in the tag above-the-fold or somewhere in the body part. diff --git a/Documentation/typo3/fluid/latest/Be/Buttons/Csh.rst b/Documentation/typo3/fluid/latest/Be/Buttons/Csh.rst index 9f20f90..34cc3cf 100644 --- a/Documentation/typo3/fluid/latest/Be/Buttons/Csh.rst +++ b/Documentation/typo3/fluid/latest/Be/Buttons/Csh.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/CshViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/CshViewHelper.php :navigation-title: be.buttons.csh .. include:: /Includes.rst.txt .. _typo3-fluid-be-buttons-csh: ============================================== -be.buttons.csh ViewHelper `` +Be.buttons.csh ViewHelper `` ============================================== - ViewHelper which returns CSH (context sensitive help) button with icon. .. note:: @@ -41,48 +44,56 @@ Full configuration with content:: A link with text "some text to link" to link the help. +.. _typo3-fluid-be-buttons-csh_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CshViewHelper.php (GitHub) `__. .. _typo3-fluid-be-buttons-csh_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-be-buttons-csh-table: +.. _typo3-fluid-be-buttons-csh-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-fluid-be-buttons-csh-table + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Table name ('_MOD_'+module name). If not set, the current module name will be used + Table name ('_MOD_'+module name). If not set, the current module name will be used -.. _typo3-fluid-be-buttons-csh-field: +.. _typo3-fluid-be-buttons-csh-field_argument: field ----- -:aspect:`DataType` - string +.. confval:: field + :name: typo3-fluid-be-buttons-csh-field + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Field name (CSH locallang main key) + Field name (CSH locallang main key) -.. _typo3-fluid-be-buttons-csh-wrap: +.. _typo3-fluid-be-buttons-csh-wrap_argument: wrap ---- -:aspect:`DataType` - string +.. confval:: wrap + :name: typo3-fluid-be-buttons-csh-wrap + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Markup to wrap around the CSH, split by "|" + Markup to wrap around the CSH, split by "|" diff --git a/Documentation/typo3/fluid/latest/Be/Infobox.rst b/Documentation/typo3/fluid/latest/Be/Infobox.rst index f512060..c6d0d7e 100644 --- a/Documentation/typo3/fluid/latest/Be/Infobox.rst +++ b/Documentation/typo3/fluid/latest/Be/Infobox.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/InfoboxViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/InfoboxViewHelper.php :navigation-title: be.infobox .. include:: /Includes.rst.txt .. _typo3-fluid-be-infobox: ====================================== -be.infobox ViewHelper `` +Be.infobox ViewHelper `` ====================================== - ViewHelper for rendering a styled content infobox markup. States @@ -42,77 +45,81 @@ All options:: +.. _typo3-fluid-be-infobox_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `InfoboxViewHelper.php (GitHub) `__. .. _typo3-fluid-be-infobox_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-be-infobox-message: +.. contents:: + :local: + + +.. _typo3-fluid-be-infobox-message_argument: message ------- -:aspect:`DataType` - string +.. confval:: message + :name: typo3-fluid-be-infobox-message + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The message of the info box, if NULL tag content is used + The message of the info box, if NULL tag content is used -.. _typo3-fluid-be-infobox-title: +.. _typo3-fluid-be-infobox-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-be-infobox-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The title of the info box + The title of the info box -.. _typo3-fluid-be-infobox-state: +.. _typo3-fluid-be-infobox-state_argument: state ----- -:aspect:`DataType` - mixed - -:aspect:`Default` - -2 +.. confval:: state + :name: typo3-fluid-be-infobox-state + :type: mixed + :Default: -2 + :required: false -:aspect:`Required` - false -:aspect:`Description` - The state of the box, InfoboxViewHelper::STATE_* + The state of the box, InfoboxViewHelper::STATE_* -.. _typo3-fluid-be-infobox-iconname: +.. _typo3-fluid-be-infobox-iconname_argument: iconName -------- -:aspect:`DataType` - string +.. confval:: iconName + :name: typo3-fluid-be-infobox-iconname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The icon name from font awesome, NULL sets default icon + The icon name from font awesome, NULL sets default icon -.. _typo3-fluid-be-infobox-disableicon: +.. _typo3-fluid-be-infobox-disableicon_argument: disableIcon ----------- -:aspect:`DataType` - boolean +.. confval:: disableIcon + :name: typo3-fluid-be-infobox-disableicon + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set to TRUE, the icon is not rendered. + If set to TRUE, the icon is not rendered. diff --git a/Documentation/typo3/fluid/latest/Be/Labels/Csh.rst b/Documentation/typo3/fluid/latest/Be/Labels/Csh.rst index a8d58d4..1bc0992 100644 --- a/Documentation/typo3/fluid/latest/Be/Labels/Csh.rst +++ b/Documentation/typo3/fluid/latest/Be/Labels/Csh.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Labels/CshViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Labels/CshViewHelper.php :navigation-title: be.labels.csh .. include:: /Includes.rst.txt .. _typo3-fluid-be-labels-csh: ============================================ -be.labels.csh ViewHelper `` +Be.labels.csh ViewHelper `` ============================================ - ViewHelper which returns CSH (context sensitive help) label with icon hover. .. note:: @@ -33,48 +36,56 @@ Full configuration:: CSH label as known from the TYPO3 backend with some custom settings. +.. _typo3-fluid-be-labels-csh_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CshViewHelper.php (GitHub) `__. .. _typo3-fluid-be-labels-csh_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-be-labels-csh-table: +.. _typo3-fluid-be-labels-csh-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-fluid-be-labels-csh-table + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Table name ('_MOD_'+module name). If not set, the current module name will be used + Table name ('_MOD_'+module name). If not set, the current module name will be used -.. _typo3-fluid-be-labels-csh-field: +.. _typo3-fluid-be-labels-csh-field_argument: field ----- -:aspect:`DataType` - string +.. confval:: field + :name: typo3-fluid-be-labels-csh-field + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Field name (CSH locallang main key) + Field name (CSH locallang main key) -.. _typo3-fluid-be-labels-csh-label: +.. _typo3-fluid-be-labels-csh-label_argument: label ----- -:aspect:`DataType` - string +.. confval:: label + :name: typo3-fluid-be-labels-csh-label + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language label which is wrapped with the CSH + Language label which is wrapped with the CSH diff --git a/Documentation/typo3/fluid/latest/Be/Link.rst b/Documentation/typo3/fluid/latest/Be/Link.rst index 4885395..87a2921 100644 --- a/Documentation/typo3/fluid/latest/Be/Link.rst +++ b/Documentation/typo3/fluid/latest/Be/Link.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/LinkViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/LinkViewHelper.php :navigation-title: be.link .. include:: /Includes.rst.txt .. _typo3-fluid-be-link: ================================ -be.link ViewHelper `` +Be.link ViewHelper `` ================================ - A ViewHelper for creating URIs to modules. Examples @@ -19,262 +22,250 @@ URI to the web_ts module on page 92:: ``Go to web_ts`` +.. _typo3-fluid-be-link_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `LinkViewHelper.php (GitHub) `__. .. _typo3-fluid-be-link_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-be-link-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-be-link-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-be-link-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-be-link-data: +.. _typo3-fluid-be-link-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-be-link-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-be-link-aria: +.. _typo3-fluid-be-link-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-be-link-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-be-link-route: +.. _typo3-fluid-be-link-route_argument: route ----- -:aspect:`DataType` - string +.. confval:: route + :name: typo3-fluid-be-link-route + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The name of the route + The name of the route -.. _typo3-fluid-be-link-parameters: +.. _typo3-fluid-be-link-parameters_argument: parameters ---------- -:aspect:`DataType` - mixed +.. confval:: parameters + :name: typo3-fluid-be-link-parameters + :type: mixed + :Default: array () + :required: false -:aspect:`Default` - array () + An array of parameters -:aspect:`Required` - false -:aspect:`Description` - An array of parameters - -.. _typo3-fluid-be-link-referencetype: +.. _typo3-fluid-be-link-referencetype_argument: referenceType ------------- -:aspect:`DataType` - string - -:aspect:`Default` - 'absolute' +.. confval:: referenceType + :name: typo3-fluid-be-link-referencetype + :type: string + :Default: 'absolute' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The type of reference to be generated (one of the constants) + The type of reference to be generated (one of the constants) -.. _typo3-fluid-be-link-name: +.. _typo3-fluid-be-link-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-be-link-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the name of an anchor + Specifies the name of an anchor -.. _typo3-fluid-be-link-rel: +.. _typo3-fluid-be-link-rel_argument: rel --- -:aspect:`DataType` - string +.. confval:: rel + :name: typo3-fluid-be-link-rel + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the current document and the linked document + Specifies the relationship between the current document and the linked document -.. _typo3-fluid-be-link-rev: +.. _typo3-fluid-be-link-rev_argument: rev --- -:aspect:`DataType` - string +.. confval:: rev + :name: typo3-fluid-be-link-rev + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the linked document and the current document + Specifies the relationship between the linked document and the current document -.. _typo3-fluid-be-link-target: +.. _typo3-fluid-be-link-target_argument: target ------ -:aspect:`DataType` - string +.. confval:: target + :name: typo3-fluid-be-link-target + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies where to open the linked document + Specifies where to open the linked document -.. _typo3-fluid-be-link-class: +.. _typo3-fluid-be-link-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-be-link-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-be-link-dir: +.. _typo3-fluid-be-link-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-be-link-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-be-link-id: +.. _typo3-fluid-be-link-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-be-link-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-be-link-lang: +.. _typo3-fluid-be-link-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-be-link-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-be-link-style: +.. _typo3-fluid-be-link-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-be-link-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-be-link-title: +.. _typo3-fluid-be-link-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-be-link-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-be-link-accesskey: +.. _typo3-fluid-be-link-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-be-link-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-be-link-tabindex: +.. _typo3-fluid-be-link-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-be-link-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-be-link-onclick: +.. _typo3-fluid-be-link-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-be-link-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event diff --git a/Documentation/typo3/fluid/latest/Be/Menus/ActionMenu.rst b/Documentation/typo3/fluid/latest/Be/Menus/ActionMenu.rst index 8fdb56e..424f25d 100644 --- a/Documentation/typo3/fluid/latest/Be/Menus/ActionMenu.rst +++ b/Documentation/typo3/fluid/latest/Be/Menus/ActionMenu.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuViewHelper.php :navigation-title: be.menus.actionMenu .. include:: /Includes.rst.txt .. _typo3-fluid-be-menus-actionmenu: ======================================================== -be.menus.actionMenu ViewHelper `` +Be.menus.actionMenu ViewHelper `` ======================================================== - ViewHelper which returns a select box, that can be used to switch between multiple actions and controllers and looks similar to TYPO3s funcMenu. @@ -36,61 +39,68 @@ Localized:: Localized select box. +.. _typo3-fluid-be-menus-actionmenu_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ActionMenuViewHelper.php (GitHub) `__. .. _typo3-fluid-be-menus-actionmenu_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-be-menus-actionmenu-additionalattributes: +.. _typo3-fluid-be-menus-actionmenu-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-be-menus-actionmenu-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-be-menus-actionmenu-data: +.. _typo3-fluid-be-menus-actionmenu-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-be-menus-actionmenu-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-be-menus-actionmenu-aria: +.. _typo3-fluid-be-menus-actionmenu-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-be-menus-actionmenu-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-be-menus-actionmenu-defaultcontroller: +.. _typo3-fluid-be-menus-actionmenu-defaultcontroller_argument: defaultController ----------------- -:aspect:`DataType` - string +.. confval:: defaultController + :name: typo3-fluid-be-menus-actionmenu-defaultcontroller + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The default controller to be used + The default controller to be used diff --git a/Documentation/typo3/fluid/latest/Be/Menus/ActionMenuItem.rst b/Documentation/typo3/fluid/latest/Be/Menus/ActionMenuItem.rst index 037a15e..c7a26e7 100644 --- a/Documentation/typo3/fluid/latest/Be/Menus/ActionMenuItem.rst +++ b/Documentation/typo3/fluid/latest/Be/Menus/ActionMenuItem.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemViewHelper.php :navigation-title: be.menus.actionMenuItem .. include:: /Includes.rst.txt .. _typo3-fluid-be-menus-actionmenuitem: ================================================================ -be.menus.actionMenuItem ViewHelper `` +Be.menus.actionMenuItem ViewHelper `` ================================================================ - ViewHelper which returns an option tag. This ViewHelper only works in conjunction with :php:`\TYPO3\CMS\Fluid\ViewHelpers\Be\Menus\ActionMenuViewHelper`. This ViewHelper is tailored to be used only in extbase context. @@ -37,103 +40,105 @@ Localized:: Localized select box. +.. _typo3-fluid-be-menus-actionmenuitem_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ActionMenuItemViewHelper.php (GitHub) `__. .. _typo3-fluid-be-menus-actionmenuitem_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-be-menus-actionmenuitem-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-be-menus-actionmenuitem-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-be-menus-actionmenuitem-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-be-menus-actionmenuitem-data: +.. _typo3-fluid-be-menus-actionmenuitem-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-be-menus-actionmenuitem-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-be-menus-actionmenuitem-aria: +.. _typo3-fluid-be-menus-actionmenuitem-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-be-menus-actionmenuitem-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-be-menus-actionmenuitem-label: +.. _typo3-fluid-be-menus-actionmenuitem-label_argument: label ----- -:aspect:`DataType` - string +.. confval:: label + :name: typo3-fluid-be-menus-actionmenuitem-label + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Label of the option tag + Label of the option tag -.. _typo3-fluid-be-menus-actionmenuitem-controller: +.. _typo3-fluid-be-menus-actionmenuitem-controller_argument: controller ---------- -:aspect:`DataType` - string +.. confval:: controller + :name: typo3-fluid-be-menus-actionmenuitem-controller + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Controller to be associated with this ActionMenuItem + Controller to be associated with this ActionMenuItem -.. _typo3-fluid-be-menus-actionmenuitem-action: +.. _typo3-fluid-be-menus-actionmenuitem-action_argument: action ------ -:aspect:`DataType` - string +.. confval:: action + :name: typo3-fluid-be-menus-actionmenuitem-action + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The action to be associated with this ActionMenuItem + The action to be associated with this ActionMenuItem -.. _typo3-fluid-be-menus-actionmenuitem-arguments: +.. _typo3-fluid-be-menus-actionmenuitem-arguments_argument: arguments --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: arguments + :name: typo3-fluid-be-menus-actionmenuitem-arguments + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional controller arguments to be passed to the action when this ActionMenuItem is selected + Additional controller arguments to be passed to the action when this ActionMenuItem is selected diff --git a/Documentation/typo3/fluid/latest/Be/Menus/ActionMenuItemGroup.rst b/Documentation/typo3/fluid/latest/Be/Menus/ActionMenuItemGroup.rst index c365e85..6a82278 100644 --- a/Documentation/typo3/fluid/latest/Be/Menus/ActionMenuItemGroup.rst +++ b/Documentation/typo3/fluid/latest/Be/Menus/ActionMenuItemGroup.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemGroupViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemGroupViewHelper.php :navigation-title: be.menus.actionMenuItemGroup .. include:: /Includes.rst.txt .. _typo3-fluid-be-menus-actionmenuitemgroup: ========================================================================== -be.menus.actionMenuItemGroup ViewHelper `` +Be.menus.actionMenuItemGroup ViewHelper `` ========================================================================== - ViewHelper which groups options of an option tag. Example @@ -28,74 +31,80 @@ Example +.. _typo3-fluid-be-menus-actionmenuitemgroup_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ActionMenuItemGroupViewHelper.php (GitHub) `__. .. _typo3-fluid-be-menus-actionmenuitemgroup_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-be-menus-actionmenuitemgroup-additionalattributes: +.. _typo3-fluid-be-menus-actionmenuitemgroup-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-be-menus-actionmenuitemgroup-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-be-menus-actionmenuitemgroup-data: +.. _typo3-fluid-be-menus-actionmenuitemgroup-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-be-menus-actionmenuitemgroup-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-be-menus-actionmenuitemgroup-aria: +.. _typo3-fluid-be-menus-actionmenuitemgroup-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-be-menus-actionmenuitemgroup-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-be-menus-actionmenuitemgroup-defaultcontroller: +.. _typo3-fluid-be-menus-actionmenuitemgroup-defaultcontroller_argument: defaultController ----------------- -:aspect:`DataType` - string +.. confval:: defaultController + :name: typo3-fluid-be-menus-actionmenuitemgroup-defaultcontroller + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unused + Unused -.. _typo3-fluid-be-menus-actionmenuitemgroup-label: +.. _typo3-fluid-be-menus-actionmenuitemgroup-label_argument: label ----- -:aspect:`DataType` - string +.. confval:: label + :name: typo3-fluid-be-menus-actionmenuitemgroup-label + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The label of the option group + The label of the option group diff --git a/Documentation/typo3/fluid/latest/Be/PageInfo.rst b/Documentation/typo3/fluid/latest/Be/PageInfo.rst index 6a8f7be..845e341 100644 --- a/Documentation/typo3/fluid/latest/Be/PageInfo.rst +++ b/Documentation/typo3/fluid/latest/Be/PageInfo.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageInfoViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageInfoViewHelper.php :navigation-title: be.pageInfo .. include:: /Includes.rst.txt .. _typo3-fluid-be-pageinfo: ======================================== -be.pageInfo ViewHelper `` +Be.pageInfo ViewHelper `` ======================================== - ViewHelper which return page info icon as known from TYPO3 backend modules. .. note:: @@ -22,11 +25,11 @@ Default:: Page info icon with context menu +.. _typo3-fluid-be-pageinfo_source: -.. _typo3-fluid-be-pageinfo_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `PageInfoViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3/fluid/latest/Be/PagePath.rst b/Documentation/typo3/fluid/latest/Be/PagePath.rst index 9ae1e6a..2fe3b79 100644 --- a/Documentation/typo3/fluid/latest/Be/PagePath.rst +++ b/Documentation/typo3/fluid/latest/Be/PagePath.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/PagePathViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/PagePathViewHelper.php :navigation-title: be.pagePath .. include:: /Includes.rst.txt .. _typo3-fluid-be-pagepath: ======================================== -be.pagePath ViewHelper `` +Be.pagePath ViewHelper `` ======================================== - ViewHelper which returns the current page path as known from TYPO3 backend modules. .. note:: @@ -22,11 +25,11 @@ Default:: Current page path, prefixed with "Path:" and wrapped in a span with the class ``typo3-docheader-pagePath``. +.. _typo3-fluid-be-pagepath_source: -.. _typo3-fluid-be-pagepath_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `PagePathViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3/fluid/latest/Be/PageRenderer.rst b/Documentation/typo3/fluid/latest/Be/PageRenderer.rst index 64d18fc..80935f1 100644 --- a/Documentation/typo3/fluid/latest/Be/PageRenderer.rst +++ b/Documentation/typo3/fluid/latest/Be/PageRenderer.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageRendererViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageRendererViewHelper.php :navigation-title: be.pageRenderer .. include:: /Includes.rst.txt .. _typo3-fluid-be-pagerenderer: ================================================ -be.pageRenderer ViewHelper `` +Be.pageRenderer ViewHelper `` ================================================ - ViewHelper to register backend module resources like CSS and JavaScript using the PageRenderer. Examples @@ -28,100 +31,104 @@ All options:: This will load the specified css, js files and requireJs modules, adds a custom js inline setting, and adds a resolved label to be used in js. +.. _typo3-fluid-be-pagerenderer_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `PageRendererViewHelper.php (GitHub) `__. .. _typo3-fluid-be-pagerenderer_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-be-pagerenderer-pagetitle: +.. _typo3-fluid-be-pagerenderer-pagetitle_argument: pageTitle --------- -:aspect:`DataType` - string +.. confval:: pageTitle + :name: typo3-fluid-be-pagerenderer-pagetitle + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Title tag of the module. Not required by default, as BE modules are shown in a frame + Title tag of the module. Not required by default, as BE modules are shown in a frame -.. _typo3-fluid-be-pagerenderer-includecssfiles: +.. _typo3-fluid-be-pagerenderer-includecssfiles_argument: includeCssFiles --------------- -:aspect:`DataType` - mixed +.. confval:: includeCssFiles + :name: typo3-fluid-be-pagerenderer-includecssfiles + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - List of custom CSS file to be loaded + List of custom CSS file to be loaded -.. _typo3-fluid-be-pagerenderer-includejsfiles: +.. _typo3-fluid-be-pagerenderer-includejsfiles_argument: includeJsFiles -------------- -:aspect:`DataType` - mixed +.. confval:: includeJsFiles + :name: typo3-fluid-be-pagerenderer-includejsfiles + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - List of custom JavaScript file to be loaded + List of custom JavaScript file to be loaded -.. _typo3-fluid-be-pagerenderer-addjsinlinelabels: +.. _typo3-fluid-be-pagerenderer-addjsinlinelabels_argument: addJsInlineLabels ----------------- -:aspect:`DataType` - mixed +.. confval:: addJsInlineLabels + :name: typo3-fluid-be-pagerenderer-addjsinlinelabels + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Custom labels to add to JavaScript inline labels + Custom labels to add to JavaScript inline labels -.. _typo3-fluid-be-pagerenderer-includejavascriptmodules: +.. _typo3-fluid-be-pagerenderer-includejavascriptmodules_argument: includeJavaScriptModules ------------------------ -:aspect:`DataType` - mixed +.. confval:: includeJavaScriptModules + :name: typo3-fluid-be-pagerenderer-includejavascriptmodules + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - List of JavaScript modules to be loaded + List of JavaScript modules to be loaded -.. _typo3-fluid-be-pagerenderer-includerequirejsmodules: +.. _typo3-fluid-be-pagerenderer-includerequirejsmodules_argument: includeRequireJsModules ----------------------- -:aspect:`DataType` - mixed +.. confval:: includeRequireJsModules + :name: typo3-fluid-be-pagerenderer-includerequirejsmodules + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - List of RequireJS modules to be loaded + List of RequireJS modules to be loaded -.. _typo3-fluid-be-pagerenderer-addinlinesettings: +.. _typo3-fluid-be-pagerenderer-addinlinesettings_argument: addInlineSettings ----------------- -:aspect:`DataType` - mixed +.. confval:: addInlineSettings + :name: typo3-fluid-be-pagerenderer-addinlinesettings + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Adds Javascript Inline Setting + Adds Javascript Inline Setting diff --git a/Documentation/typo3/fluid/latest/Be/Security/IfAuthenticated.rst b/Documentation/typo3/fluid/latest/Be/Security/IfAuthenticated.rst index c614c09..ef668ca 100644 --- a/Documentation/typo3/fluid/latest/Be/Security/IfAuthenticated.rst +++ b/Documentation/typo3/fluid/latest/Be/Security/IfAuthenticated.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfAuthenticatedViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfAuthenticatedViewHelper.php :navigation-title: be.security.ifAuthenticated .. include:: /Includes.rst.txt .. _typo3-fluid-be-security-ifauthenticated: ======================================================================== -be.security.ifAuthenticated ViewHelper `` +Be.security.ifAuthenticated ViewHelper `` ======================================================================== - This ViewHelper implements an ifAuthenticated/else condition for backend users and backend groups. @@ -37,35 +40,44 @@ IfAuthenticated / then / else:: Everything inside the :html:`` is displayed the backend user is logged in. :html:`` is displayed if no backend user is logged in. +.. _typo3-fluid-be-security-ifauthenticated_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IfAuthenticatedViewHelper.php (GitHub) `__. .. _typo3-fluid-be-security-ifauthenticated_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-be-security-ifauthenticated-then: +.. _typo3-fluid-be-security-ifauthenticated-then_argument: then ---- -:aspect:`DataType` - mixed +.. confval:: then + :name: typo3-fluid-be-security-ifauthenticated-then + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if met. + Value to be returned if the condition if met. -.. _typo3-fluid-be-security-ifauthenticated-else: +.. _typo3-fluid-be-security-ifauthenticated-else_argument: else ---- -:aspect:`DataType` - mixed +.. confval:: else + :name: typo3-fluid-be-security-ifauthenticated-else + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if not met. + Value to be returned if the condition if not met. diff --git a/Documentation/typo3/fluid/latest/Be/Security/IfHasRole.rst b/Documentation/typo3/fluid/latest/Be/Security/IfHasRole.rst index 46af2ed..80b65b6 100644 --- a/Documentation/typo3/fluid/latest/Be/Security/IfHasRole.rst +++ b/Documentation/typo3/fluid/latest/Be/Security/IfHasRole.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfHasRoleViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfHasRoleViewHelper.php :navigation-title: be.security.ifHasRole .. include:: /Includes.rst.txt .. _typo3-fluid-be-security-ifhasrole: ============================================================ -be.security.ifHasRole ViewHelper `` +Be.security.ifHasRole ViewHelper `` ============================================================ - This ViewHelper implements an ifHasRole/else condition for backend users and backend groups. @@ -50,48 +53,56 @@ Everything inside the :html:`` tag is displayed if the logged in backend user belongs to the specified backend group. Otherwise, everything inside the :html:`` tag is displayed. +.. _typo3-fluid-be-security-ifhasrole_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IfHasRoleViewHelper.php (GitHub) `__. .. _typo3-fluid-be-security-ifhasrole_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-be-security-ifhasrole-then: +.. _typo3-fluid-be-security-ifhasrole-then_argument: then ---- -:aspect:`DataType` - mixed +.. confval:: then + :name: typo3-fluid-be-security-ifhasrole-then + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if met. + Value to be returned if the condition if met. -.. _typo3-fluid-be-security-ifhasrole-else: +.. _typo3-fluid-be-security-ifhasrole-else_argument: else ---- -:aspect:`DataType` - mixed +.. confval:: else + :name: typo3-fluid-be-security-ifhasrole-else + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if not met. + Value to be returned if the condition if not met. -.. _typo3-fluid-be-security-ifhasrole-role: +.. _typo3-fluid-be-security-ifhasrole-role_argument: role ---- -:aspect:`DataType` - string +.. confval:: role + :name: typo3-fluid-be-security-ifhasrole-role + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The usergroup (either the usergroup uid or its title). + The usergroup (either the usergroup uid or its title). diff --git a/Documentation/typo3/fluid/latest/Be/TableList.rst b/Documentation/typo3/fluid/latest/Be/TableList.rst index dcabe2e..21a9b4c 100644 --- a/Documentation/typo3/fluid/latest/Be/TableList.rst +++ b/Documentation/typo3/fluid/latest/Be/TableList.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/TableListViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/TableListViewHelper.php :navigation-title: be.tableList .. include:: /Includes.rst.txt .. _typo3-fluid-be-tablelist: ========================================== -be.tableList ViewHelper `` +Be.tableList ViewHelper `` ========================================== - ViewHelper which renders a record list as known from the TYPO3 list module. .. note:: @@ -45,171 +48,166 @@ Full:: List of "Website user" records with a text property of ``foo`` stored on PID ``1`` and two levels down. Clicking on a username will open the TYPO3 info popup for the respective record +.. _typo3-fluid-be-tablelist_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `TableListViewHelper.php (GitHub) `__. .. _typo3-fluid-be-tablelist_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-be-tablelist-tablename: +.. contents:: + :local: + + +.. _typo3-fluid-be-tablelist-tablename_argument: tableName --------- -:aspect:`DataType` - string +.. confval:: tableName + :name: typo3-fluid-be-tablelist-tablename + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Name of the database table + Name of the database table -.. _typo3-fluid-be-tablelist-fieldlist: +.. _typo3-fluid-be-tablelist-fieldlist_argument: fieldList --------- -:aspect:`DataType` - mixed +.. confval:: fieldList + :name: typo3-fluid-be-tablelist-fieldlist + :type: mixed + :Default: array () + :required: false -:aspect:`Default` - array () + List of fields to be displayed. If empty, only the title column (configured in $TCA[$tableName]['ctrl']['title']) is shown -:aspect:`Required` - false -:aspect:`Description` - List of fields to be displayed. If empty, only the title column (configured in $TCA[$tableName]['ctrl']['title']) is shown - -.. _typo3-fluid-be-tablelist-storagepid: +.. _typo3-fluid-be-tablelist-storagepid_argument: storagePid ---------- -:aspect:`DataType` - mixed +.. confval:: storagePid + :name: typo3-fluid-be-tablelist-storagepid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - By default, records are fetched from the storage PID configured in persistence.storagePid. With this argument, the storage PID can be overwritten + By default, records are fetched from the storage PID configured in persistence.storagePid. With this argument, the storage PID can be overwritten -.. _typo3-fluid-be-tablelist-levels: +.. _typo3-fluid-be-tablelist-levels_argument: levels ------ -:aspect:`DataType` - mixed +.. confval:: levels + :name: typo3-fluid-be-tablelist-levels + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Corresponds to the level selector of the TYPO3 list module. By default only records from the current storagePid are fetched + Corresponds to the level selector of the TYPO3 list module. By default only records from the current storagePid are fetched -.. _typo3-fluid-be-tablelist-filter: +.. _typo3-fluid-be-tablelist-filter_argument: filter ------ -:aspect:`DataType` - string +.. confval:: filter + :name: typo3-fluid-be-tablelist-filter + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Corresponds to the "Search String" textbox of the TYPO3 list module. If not empty, only records matching the string will be fetched + Corresponds to the "Search String" textbox of the TYPO3 list module. If not empty, only records matching the string will be fetched -.. _typo3-fluid-be-tablelist-recordsperpage: +.. _typo3-fluid-be-tablelist-recordsperpage_argument: recordsPerPage -------------- -:aspect:`DataType` - mixed +.. confval:: recordsPerPage + :name: typo3-fluid-be-tablelist-recordsperpage + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Amount of records to be displayed at once. Defaults to $TCA[$tableName]['interface']['maxSingleDBListItems'] or (if that's not set) to 100 + Amount of records to be displayed at once. Defaults to $TCA[$tableName]['interface']['maxSingleDBListItems'] or (if that's not set) to 100 -.. _typo3-fluid-be-tablelist-sortfield: +.. _typo3-fluid-be-tablelist-sortfield_argument: sortField --------- -:aspect:`DataType` - string +.. confval:: sortField + :name: typo3-fluid-be-tablelist-sortfield + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Table field to sort the results by + Table field to sort the results by -.. _typo3-fluid-be-tablelist-sortdescending: +.. _typo3-fluid-be-tablelist-sortdescending_argument: sortDescending -------------- -:aspect:`DataType` - boolean +.. confval:: sortDescending + :name: typo3-fluid-be-tablelist-sortdescending + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE records will be sorted in descending order + If TRUE records will be sorted in descending order -.. _typo3-fluid-be-tablelist-readonly: +.. _typo3-fluid-be-tablelist-readonly_argument: readOnly -------- -:aspect:`DataType` - boolean +.. confval:: readOnly + :name: typo3-fluid-be-tablelist-readonly + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, the edit icons won't be shown. Otherwise edit icons will be shown, if the current BE user has edit rights for the specified table! + If TRUE, the edit icons won't be shown. Otherwise edit icons will be shown, if the current BE user has edit rights for the specified table! -.. _typo3-fluid-be-tablelist-enableclickmenu: +.. _typo3-fluid-be-tablelist-enableclickmenu_argument: enableClickMenu --------------- -:aspect:`DataType` - boolean - -:aspect:`Default` - true +.. confval:: enableClickMenu + :name: typo3-fluid-be-tablelist-enableclickmenu + :type: boolean + :Default: true + :required: false -:aspect:`Required` - false -:aspect:`Description` - Enables context menu + Enables context menu -.. _typo3-fluid-be-tablelist-enablecontrolpanels: +.. _typo3-fluid-be-tablelist-enablecontrolpanels_argument: enableControlPanels ------------------- -:aspect:`DataType` - boolean +.. confval:: enableControlPanels + :name: typo3-fluid-be-tablelist-enablecontrolpanels + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Enables control panels + Enables control panels -.. _typo3-fluid-be-tablelist-clicktitlemode: +.. _typo3-fluid-be-tablelist-clicktitlemode_argument: clickTitleMode -------------- -:aspect:`DataType` - string +.. confval:: clickTitleMode + :name: typo3-fluid-be-tablelist-clicktitlemode + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - One of "edit", "show" (only pages, tt_content), "info + One of "edit", "show" (only pages, tt_content), "info diff --git a/Documentation/typo3/fluid/latest/Be/Uri.rst b/Documentation/typo3/fluid/latest/Be/Uri.rst index b01bc44..50f0d84 100644 --- a/Documentation/typo3/fluid/latest/Be/Uri.rst +++ b/Documentation/typo3/fluid/latest/Be/Uri.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/UriViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Be/UriViewHelper.php :navigation-title: be.uri .. include:: /Includes.rst.txt .. _typo3-fluid-be-uri: ============================== -be.uri ViewHelper `` +Be.uri ViewHelper `` ============================== - A ViewHelper for creating URIs to modules. Examples @@ -25,54 +28,58 @@ Inline notation:: ``/typo3/module/web/ts?token=b6e9c9f&id=92`` +.. _typo3-fluid-be-uri_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `UriViewHelper.php (GitHub) `__. .. _typo3-fluid-be-uri_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-be-uri-route: +.. contents:: + :local: + + +.. _typo3-fluid-be-uri-route_argument: route ----- -:aspect:`DataType` - string +.. confval:: route + :name: typo3-fluid-be-uri-route + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The name of the route + The name of the route -.. _typo3-fluid-be-uri-parameters: +.. _typo3-fluid-be-uri-parameters_argument: parameters ---------- -:aspect:`DataType` - mixed +.. confval:: parameters + :name: typo3-fluid-be-uri-parameters + :type: mixed + :Default: array () + :required: false -:aspect:`Default` - array () + An array of parameters -:aspect:`Required` - false -:aspect:`Description` - An array of parameters - -.. _typo3-fluid-be-uri-referencetype: +.. _typo3-fluid-be-uri-referencetype_argument: referenceType ------------- -:aspect:`DataType` - string - -:aspect:`Default` - 'absolute' +.. confval:: referenceType + :name: typo3-fluid-be-uri-referencetype + :type: string + :Default: 'absolute' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The type of reference to be generated (one of the constants) + The type of reference to be generated (one of the constants) diff --git a/Documentation/typo3/fluid/latest/CObject.rst b/Documentation/typo3/fluid/latest/CObject.rst index a55e690..04e7d23 100644 --- a/Documentation/typo3/fluid/latest/CObject.rst +++ b/Documentation/typo3/fluid/latest/CObject.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php :navigation-title: cObject .. include:: /Includes.rst.txt .. _typo3-fluid-cobject: ================================ -cObject ViewHelper `` +CObject ViewHelper `` ================================ - This ViewHelper renders CObjects from the global TypoScript configuration. .. note:: @@ -60,61 +63,68 @@ When passing an object with ``{data}``, the properties of the object are accessi TypoScript. If only a single value is passed or the ``currentValueKey`` is specified, :typoscript:`.current = 1` can be used in the TypoScript. +.. _typo3-fluid-cobject_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CObjectViewHelper.php (GitHub) `__. .. _typo3-fluid-cobject_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-cobject-data: +.. _typo3-fluid-cobject-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-cobject-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The data to be used for rendering the cObject. Can be an object, array or string. If this argument is not set, child nodes will be used + The data to be used for rendering the cObject. Can be an object, array or string. If this argument is not set, child nodes will be used -.. _typo3-fluid-cobject-typoscriptobjectpath: +.. _typo3-fluid-cobject-typoscriptobjectpath_argument: typoscriptObjectPath -------------------- -:aspect:`DataType` - string +.. confval:: typoscriptObjectPath + :name: typo3-fluid-cobject-typoscriptobjectpath + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The TypoScript setup path of the TypoScript object to render + The TypoScript setup path of the TypoScript object to render -.. _typo3-fluid-cobject-currentvaluekey: +.. _typo3-fluid-cobject-currentvaluekey_argument: currentValueKey --------------- -:aspect:`DataType` - string +.. confval:: currentValueKey + :name: typo3-fluid-cobject-currentvaluekey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CurrentValueKey + CurrentValueKey -.. _typo3-fluid-cobject-table: +.. _typo3-fluid-cobject-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-fluid-cobject-table + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The table name associated with "data" argument. Typically tt_content or one of your custom tables. This argument should be set if rendering a FILES cObject where file references are used, or if the data argument is a database record. + The table name associated with "data" argument. Typically tt_content or one of your custom tables. This argument should be set if rendering a FILES cObject where file references are used, or if the data argument is a database record. diff --git a/Documentation/typo3/fluid/latest/Debug.rst b/Documentation/typo3/fluid/latest/Debug.rst index 1c9212f..59ed3e7 100644 --- a/Documentation/typo3/fluid/latest/Debug.rst +++ b/Documentation/typo3/fluid/latest/Debug.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/DebugViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/DebugViewHelper.php :navigation-title: debug .. include:: /Includes.rst.txt .. _typo3-fluid-debug: ============================ -debug ViewHelper `` +Debug ViewHelper `` ============================ - This ViewHelper generates a HTML dump of the tagged variable. Examples @@ -38,103 +41,105 @@ All Features [A HTML view of the var_dump] +.. _typo3-fluid-debug_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `DebugViewHelper.php (GitHub) `__. .. _typo3-fluid-debug_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-debug-title: +.. contents:: + :local: + + +.. _typo3-fluid-debug-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-debug-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Optional custom title for the debug output + Optional custom title for the debug output -.. _typo3-fluid-debug-maxdepth: +.. _typo3-fluid-debug-maxdepth_argument: maxDepth -------- -:aspect:`DataType` - mixed - -:aspect:`Default` - 8 +.. confval:: maxDepth + :name: typo3-fluid-debug-maxdepth + :type: mixed + :Default: 8 + :required: false -:aspect:`Required` - false -:aspect:`Description` - Sets the max recursion depth of the dump (defaults to 8). De- or increase the number according to your needs and memory limit. + Sets the max recursion depth of the dump (defaults to 8). De- or increase the number according to your needs and memory limit. -.. _typo3-fluid-debug-plaintext: +.. _typo3-fluid-debug-plaintext_argument: plainText --------- -:aspect:`DataType` - boolean +.. confval:: plainText + :name: typo3-fluid-debug-plaintext + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, the dump is in plain text, if FALSE the debug output is in HTML format. + If TRUE, the dump is in plain text, if FALSE the debug output is in HTML format. -.. _typo3-fluid-debug-ansicolors: +.. _typo3-fluid-debug-ansicolors_argument: ansiColors ---------- -:aspect:`DataType` - boolean +.. confval:: ansiColors + :name: typo3-fluid-debug-ansicolors + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, ANSI color codes is added to the plaintext output, if FALSE (default) the plaintext debug output not colored. + If TRUE, ANSI color codes is added to the plaintext output, if FALSE (default) the plaintext debug output not colored. -.. _typo3-fluid-debug-inline: +.. _typo3-fluid-debug-inline_argument: inline ------ -:aspect:`DataType` - boolean +.. confval:: inline + :name: typo3-fluid-debug-inline + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, the dump is rendered at the position of the tag. If FALSE (default), the dump is displayed at the top of the page. + If TRUE, the dump is rendered at the position of the tag. If FALSE (default), the dump is displayed at the top of the page. -.. _typo3-fluid-debug-blacklistedclassnames: +.. _typo3-fluid-debug-blacklistedclassnames_argument: blacklistedClassNames --------------------- -:aspect:`DataType` - mixed +.. confval:: blacklistedClassNames + :name: typo3-fluid-debug-blacklistedclassnames + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - An array of class names (RegEx) to be filtered. Default is an array of some common class names. + An array of class names (RegEx) to be filtered. Default is an array of some common class names. -.. _typo3-fluid-debug-blacklistedpropertynames: +.. _typo3-fluid-debug-blacklistedpropertynames_argument: blacklistedPropertyNames ------------------------ -:aspect:`DataType` - mixed +.. confval:: blacklistedPropertyNames + :name: typo3-fluid-debug-blacklistedpropertynames + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - An array of property names and/or array keys (RegEx) to be filtered. Default is an array of some common property names. + An array of property names and/or array keys (RegEx) to be filtered. Default is an array of some common property names. diff --git a/Documentation/typo3/fluid/latest/Debug/Render.rst b/Documentation/typo3/fluid/latest/Debug/Render.rst index bad1f56..4c1d2a2 100644 --- a/Documentation/typo3/fluid/latest/Debug/Render.rst +++ b/Documentation/typo3/fluid/latest/Debug/Render.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php :navigation-title: debug.render .. include:: /Includes.rst.txt .. _typo3-fluid-debug-render: ========================================== -debug.render ViewHelper `` +Debug.render ViewHelper `` ========================================== - Debuggable version of :ref:`f:render ` - performs the same rendering operation but wraps the output with HTML that can be inspected with the admin panel in frontend. @@ -16,106 +19,106 @@ Replaces ``f:render`` when the admin panel decides (see :php:`ViewHelperResolver` class). Also possible to use explicitly by using ``f:debug.render`` instead of the normal ``f:render`` statement. +.. _typo3-fluid-debug-render_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `RenderViewHelper.php (GitHub) `__. .. _typo3-fluid-debug-render_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-debug-render-debug: +.. contents:: + :local: + + +.. _typo3-fluid-debug-render-debug_argument: debug ----- -:aspect:`DataType` - boolean +.. confval:: debug + :name: typo3-fluid-debug-render-debug + :type: boolean + :Default: true + :required: false -:aspect:`Default` - true + If true, the admin panel shows debug information if activated, -:aspect:`Required` - false -:aspect:`Description` - If true, the admin panel shows debug information if activated, - -.. _typo3-fluid-debug-render-section: +.. _typo3-fluid-debug-render-section_argument: section ------- -:aspect:`DataType` - string +.. confval:: section + :name: typo3-fluid-debug-render-section + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Section to render - combine with partial to render section in partial + Section to render - combine with partial to render section in partial -.. _typo3-fluid-debug-render-partial: +.. _typo3-fluid-debug-render-partial_argument: partial ------- -:aspect:`DataType` - string +.. confval:: partial + :name: typo3-fluid-debug-render-partial + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Partial to render, with or without section + Partial to render, with or without section -.. _typo3-fluid-debug-render-arguments: +.. _typo3-fluid-debug-render-arguments_argument: arguments --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: arguments + :name: typo3-fluid-debug-render-arguments + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Array of variables to be transferred. Use {_all} for all variables + Array of variables to be transferred. Use {_all} for all variables -.. _typo3-fluid-debug-render-optional: +.. _typo3-fluid-debug-render-optional_argument: optional -------- -:aspect:`DataType` - boolean +.. confval:: optional + :name: typo3-fluid-debug-render-optional + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, considers the *section* optional. Partial never is. + If TRUE, considers the *section* optional. Partial never is. -.. _typo3-fluid-debug-render-default: +.. _typo3-fluid-debug-render-default_argument: default ------- -:aspect:`DataType` - mixed +.. confval:: default + :name: typo3-fluid-debug-render-default + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value (usually string) to be displayed if the section or partial does not exist + Value (usually string) to be displayed if the section or partial does not exist -.. _typo3-fluid-debug-render-contentas: +.. _typo3-fluid-debug-render-contentas_argument: contentAs --------- -:aspect:`DataType` - string +.. confval:: contentAs + :name: typo3-fluid-debug-render-contentas + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If used, renders the child content and adds it as a template variable with this name for use in the partial/section + If used, renders the child content and adds it as a template variable with this name for use in the partial/section diff --git a/Documentation/typo3/fluid/latest/FlashMessages.rst b/Documentation/typo3/fluid/latest/FlashMessages.rst index 38954ab..70dd10d 100644 --- a/Documentation/typo3/fluid/latest/FlashMessages.rst +++ b/Documentation/typo3/fluid/latest/FlashMessages.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php :navigation-title: flashMessages .. include:: /Includes.rst.txt .. _typo3-fluid-flashmessages: ============================================ -flashMessages ViewHelper `` +FlashMessages ViewHelper `` ============================================ - ViewHelper which renders the flash messages (if there are any) as an unsorted list. In case you need custom Flash Message HTML output, please write your own ViewHelper for the moment. @@ -81,35 +84,44 @@ Using a specific queue +.. _typo3-fluid-flashmessages_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `FlashMessagesViewHelper.php (GitHub) `__. .. _typo3-fluid-flashmessages_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-flashmessages-queueidentifier: +.. _typo3-fluid-flashmessages-queueidentifier_argument: queueIdentifier --------------- -:aspect:`DataType` - string +.. confval:: queueIdentifier + :name: typo3-fluid-flashmessages-queueidentifier + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Flash-message queue to use + Flash-message queue to use -.. _typo3-fluid-flashmessages-as: +.. _typo3-fluid-flashmessages-as_argument: as -- -:aspect:`DataType` - string +.. confval:: as + :name: typo3-fluid-flashmessages-as + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The name of the current flashMessage variable for rendering inside + The name of the current flashMessage variable for rendering inside diff --git a/Documentation/typo3/fluid/latest/Form.rst b/Documentation/typo3/fluid/latest/Form.rst index c59a652..5b0080e 100644 --- a/Documentation/typo3/fluid/latest/Form.rst +++ b/Documentation/typo3/fluid/latest/Form.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/FormViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/FormViewHelper.php :navigation-title: form .. include:: /Includes.rst.txt .. _typo3-fluid-form: ========================== -form ViewHelper `` +Form ViewHelper `` ========================== - Form ViewHelper. Generates a :html:`
` Tag. Tailored for extbase plugins, uses extbase Request. Basic usage @@ -41,541 +44,504 @@ Binding a domain object to a form:: This automatically inserts the value of ``{customer.name}`` inside the textarea and adjusts the name of the textarea accordingly. +.. _typo3-fluid-form_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `FormViewHelper.php (GitHub) `__. .. _typo3-fluid-form_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: -.. _typo3-fluid-form-additionalattributes: + +.. _typo3-fluid-form-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-data: +.. _typo3-fluid-form-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-aria: +.. _typo3-fluid-form-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-action: +.. _typo3-fluid-form-action_argument: action ------ -:aspect:`DataType` - string +.. confval:: action + :name: typo3-fluid-form-action + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target action + Target action -.. _typo3-fluid-form-arguments: +.. _typo3-fluid-form-arguments_argument: arguments --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: arguments + :name: typo3-fluid-form-arguments + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments + Arguments -.. _typo3-fluid-form-controller: +.. _typo3-fluid-form-controller_argument: controller ---------- -:aspect:`DataType` - string +.. confval:: controller + :name: typo3-fluid-form-controller + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target controller + Target controller -.. _typo3-fluid-form-extensionname: +.. _typo3-fluid-form-extensionname_argument: extensionName ------------- -:aspect:`DataType` - string +.. confval:: extensionName + :name: typo3-fluid-form-extensionname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target Extension Name (without `tx_` prefix and no underscores). If NULL the current extension name is used + Target Extension Name (without `tx_` prefix and no underscores). If NULL the current extension name is used -.. _typo3-fluid-form-pluginname: +.. _typo3-fluid-form-pluginname_argument: pluginName ---------- -:aspect:`DataType` - string +.. confval:: pluginName + :name: typo3-fluid-form-pluginname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target plugin. If empty, the current plugin name is used + Target plugin. If empty, the current plugin name is used -.. _typo3-fluid-form-pageuid: +.. _typo3-fluid-form-pageuid_argument: pageUid ------- -:aspect:`DataType` - mixed +.. confval:: pageUid + :name: typo3-fluid-form-pageuid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target page uid + Target page uid -.. _typo3-fluid-form-object: +.. _typo3-fluid-form-object_argument: object ------ -:aspect:`DataType` - mixed +.. confval:: object + :name: typo3-fluid-form-object + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Object to use for the form. Use in conjunction with the "property" attribute on the sub tags + Object to use for the form. Use in conjunction with the "property" attribute on the sub tags -.. _typo3-fluid-form-pagetype: +.. _typo3-fluid-form-pagetype_argument: pageType -------- -:aspect:`DataType` - mixed +.. confval:: pageType + :name: typo3-fluid-form-pagetype + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target page type + Target page type -.. _typo3-fluid-form-nocache: +.. _typo3-fluid-form-nocache_argument: noCache ------- -:aspect:`DataType` - boolean +.. confval:: noCache + :name: typo3-fluid-form-nocache + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Set this to disable caching for the target page. You should not need this. + Set this to disable caching for the target page. You should not need this. -.. _typo3-fluid-form-section: +.. _typo3-fluid-form-section_argument: section ------- -:aspect:`DataType` - string +.. confval:: section + :name: typo3-fluid-form-section + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The anchor to be added to the action URI (only active if $actionUri is not set) + The anchor to be added to the action URI (only active if $actionUri is not set) -.. _typo3-fluid-form-format: +.. _typo3-fluid-form-format_argument: format ------ -:aspect:`DataType` - string +.. confval:: format + :name: typo3-fluid-form-format + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The requested format (e.g. ".html") of the target page (only active if $actionUri is not set) + The requested format (e.g. ".html") of the target page (only active if $actionUri is not set) -.. _typo3-fluid-form-additionalparams: +.. _typo3-fluid-form-additionalparams_argument: additionalParams ---------------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: additionalParams + :name: typo3-fluid-form-additionalparams + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional action URI query parameters that won't be prefixed like $arguments (overrule $arguments) (only active if $actionUri is not set) + Additional action URI query parameters that won't be prefixed like $arguments (overrule $arguments) (only active if $actionUri is not set) -.. _typo3-fluid-form-absolute: +.. _typo3-fluid-form-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-form-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, an absolute action URI is rendered (only active if $actionUri is not set) + If set, an absolute action URI is rendered (only active if $actionUri is not set) -.. _typo3-fluid-form-addquerystring: +.. _typo3-fluid-form-addquerystring_argument: addQueryString -------------- -:aspect:`DataType` - string +.. confval:: addQueryString + :name: typo3-fluid-form-addquerystring + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. + If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. -.. _typo3-fluid-form-argumentstobeexcludedfromquerystring: +.. _typo3-fluid-form-argumentstobeexcludedfromquerystring_argument: argumentsToBeExcludedFromQueryString ------------------------------------ -:aspect:`DataType` - mixed +.. confval:: argumentsToBeExcludedFromQueryString + :name: typo3-fluid-form-argumentstobeexcludedfromquerystring + :type: mixed + :Default: array () + :required: false -:aspect:`Default` - array () + Arguments to be removed from the action URI. Only active if $addQueryString = TRUE and $actionUri is not set -:aspect:`Required` - false -:aspect:`Description` - Arguments to be removed from the action URI. Only active if $addQueryString = TRUE and $actionUri is not set - -.. _typo3-fluid-form-fieldnameprefix: +.. _typo3-fluid-form-fieldnameprefix_argument: fieldNamePrefix --------------- -:aspect:`DataType` - string +.. confval:: fieldNamePrefix + :name: typo3-fluid-form-fieldnameprefix + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Prefix that will be added to all field names within this form. If not set the prefix will be tx_yourExtension_plugin + Prefix that will be added to all field names within this form. If not set the prefix will be tx_yourExtension_plugin -.. _typo3-fluid-form-actionuri: +.. _typo3-fluid-form-actionuri_argument: actionUri --------- -:aspect:`DataType` - string +.. confval:: actionUri + :name: typo3-fluid-form-actionuri + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Can be used to overwrite the "action" attribute of the form tag + Can be used to overwrite the "action" attribute of the form tag -.. _typo3-fluid-form-objectname: +.. _typo3-fluid-form-objectname_argument: objectName ---------- -:aspect:`DataType` - string +.. confval:: objectName + :name: typo3-fluid-form-objectname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of the object that is bound to this form. If this argument is not specified, the name attribute of this form is used to determine the FormObjectName + Name of the object that is bound to this form. If this argument is not specified, the name attribute of this form is used to determine the FormObjectName -.. _typo3-fluid-form-hiddenfieldclassname: +.. _typo3-fluid-form-hiddenfieldclassname_argument: hiddenFieldClassName -------------------- -:aspect:`DataType` - string +.. confval:: hiddenFieldClassName + :name: typo3-fluid-form-hiddenfieldclassname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - HiddenFieldClassName + HiddenFieldClassName -.. _typo3-fluid-form-requesttoken: +.. _typo3-fluid-form-requesttoken_argument: requestToken ------------ -:aspect:`DataType` - mixed +.. confval:: requestToken + :name: typo3-fluid-form-requesttoken + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Whether to add that request token to the form + Whether to add that request token to the form -.. _typo3-fluid-form-signingtype: +.. _typo3-fluid-form-signingtype_argument: signingType ----------- -:aspect:`DataType` - string +.. confval:: signingType + :name: typo3-fluid-form-signingtype + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Which signing type to be used on the request token (falls back to "nonce") + Which signing type to be used on the request token (falls back to "nonce") -.. _typo3-fluid-form-enctype: +.. _typo3-fluid-form-enctype_argument: enctype ------- -:aspect:`DataType` - string +.. confval:: enctype + :name: typo3-fluid-form-enctype + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - MIME type with which the form is submitted + MIME type with which the form is submitted -.. _typo3-fluid-form-method: +.. _typo3-fluid-form-method_argument: method ------ -:aspect:`DataType` - string - -:aspect:`Default` - 'post' +.. confval:: method + :name: typo3-fluid-form-method + :type: string + :Default: 'post' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Transfer type (get or post) + Transfer type (get or post) -.. _typo3-fluid-form-name: +.. _typo3-fluid-form-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of form + Name of form -.. _typo3-fluid-form-onreset: +.. _typo3-fluid-form-onreset_argument: onreset ------- -:aspect:`DataType` - string +.. confval:: onreset + :name: typo3-fluid-form-onreset + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript: On reset of the form + JavaScript: On reset of the form -.. _typo3-fluid-form-onsubmit: +.. _typo3-fluid-form-onsubmit_argument: onsubmit -------- -:aspect:`DataType` - string +.. confval:: onsubmit + :name: typo3-fluid-form-onsubmit + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript: On submit of the form + JavaScript: On submit of the form -.. _typo3-fluid-form-target: +.. _typo3-fluid-form-target_argument: target ------ -:aspect:`DataType` - string +.. confval:: target + :name: typo3-fluid-form-target + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target attribute of the form + Target attribute of the form -.. _typo3-fluid-form-novalidate: +.. _typo3-fluid-form-novalidate_argument: novalidate ---------- -:aspect:`DataType` - boolean +.. confval:: novalidate + :name: typo3-fluid-form-novalidate + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Indicate that the form is not to be validated on submit. + Indicate that the form is not to be validated on submit. -.. _typo3-fluid-form-class: +.. _typo3-fluid-form-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-dir: +.. _typo3-fluid-form-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-id: +.. _typo3-fluid-form-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-lang: +.. _typo3-fluid-form-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-style: +.. _typo3-fluid-form-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-title: +.. _typo3-fluid-form-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-accesskey: +.. _typo3-fluid-form-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-tabindex: +.. _typo3-fluid-form-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-onclick: +.. _typo3-fluid-form-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event diff --git a/Documentation/typo3/fluid/latest/Form/Button.rst b/Documentation/typo3/fluid/latest/Form/Button.rst index c3cf72d..1782835 100644 --- a/Documentation/typo3/fluid/latest/Form/Button.rst +++ b/Documentation/typo3/fluid/latest/Form/Button.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/ButtonViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/ButtonViewHelper.php :navigation-title: form.button .. include:: /Includes.rst.txt .. _typo3-fluid-form-button: ======================================== -form.button ViewHelper `` +Form.button ViewHelper `` ======================================== - Creates a button. Examples @@ -34,324 +37,309 @@ Output:: +.. _typo3-fluid-form-button_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ButtonViewHelper.php (GitHub) `__. .. _typo3-fluid-form-button_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-button-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-form-button-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-button-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-button-data: +.. _typo3-fluid-form-button-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-button-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-button-aria: +.. _typo3-fluid-form-button-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-button-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-button-name: +.. _typo3-fluid-form-button-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-button-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-button-value: +.. _typo3-fluid-form-button-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-form-button-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value of input tag + Value of input tag -.. _typo3-fluid-form-button-property: +.. _typo3-fluid-form-button-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-button-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-button-autofocus: +.. _typo3-fluid-form-button-autofocus_argument: autofocus --------- -:aspect:`DataType` - string +.. confval:: autofocus + :name: typo3-fluid-form-button-autofocus + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that a button should automatically get focus when the page loads + Specifies that a button should automatically get focus when the page loads -.. _typo3-fluid-form-button-disabled: +.. _typo3-fluid-form-button-disabled_argument: disabled -------- -:aspect:`DataType` - string +.. confval:: disabled + :name: typo3-fluid-form-button-disabled + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be disabled when the page loads + Specifies that the input element should be disabled when the page loads -.. _typo3-fluid-form-button-form: +.. _typo3-fluid-form-button-form_argument: form ---- -:aspect:`DataType` - string +.. confval:: form + :name: typo3-fluid-form-button-form + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies one or more forms the button belongs to + Specifies one or more forms the button belongs to -.. _typo3-fluid-form-button-formaction: +.. _typo3-fluid-form-button-formaction_argument: formaction ---------- -:aspect:`DataType` - string +.. confval:: formaction + :name: typo3-fluid-form-button-formaction + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies where to send the form-data when a form is submitted. Only for type="submit" + Specifies where to send the form-data when a form is submitted. Only for type="submit" -.. _typo3-fluid-form-button-formenctype: +.. _typo3-fluid-form-button-formenctype_argument: formenctype ----------- -:aspect:`DataType` - string +.. confval:: formenctype + :name: typo3-fluid-form-button-formenctype + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies how form-data should be encoded before sending it to a server. Only for type="submit" (e.g. "application/x-www-form-urlencoded", "multipart/form-data" or "text/plain") + Specifies how form-data should be encoded before sending it to a server. Only for type="submit" (e.g. "application/x-www-form-urlencoded", "multipart/form-data" or "text/plain") -.. _typo3-fluid-form-button-formmethod: +.. _typo3-fluid-form-button-formmethod_argument: formmethod ---------- -:aspect:`DataType` - string +.. confval:: formmethod + :name: typo3-fluid-form-button-formmethod + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies how to send the form-data (which HTTP method to use). Only for type="submit" (e.g. "get" or "post") + Specifies how to send the form-data (which HTTP method to use). Only for type="submit" (e.g. "get" or "post") -.. _typo3-fluid-form-button-formnovalidate: +.. _typo3-fluid-form-button-formnovalidate_argument: formnovalidate -------------- -:aspect:`DataType` - string +.. confval:: formnovalidate + :name: typo3-fluid-form-button-formnovalidate + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the form-data should not be validated on submission. Only for type="submit" + Specifies that the form-data should not be validated on submission. Only for type="submit" -.. _typo3-fluid-form-button-formtarget: +.. _typo3-fluid-form-button-formtarget_argument: formtarget ---------- -:aspect:`DataType` - string +.. confval:: formtarget + :name: typo3-fluid-form-button-formtarget + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies where to display the response after submitting the form. Only for type="submit" (e.g. "_blank", "_self", "_parent", "_top", "framename") + Specifies where to display the response after submitting the form. Only for type="submit" (e.g. "_blank", "_self", "_parent", "_top", "framename") -.. _typo3-fluid-form-button-class: +.. _typo3-fluid-form-button-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-button-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-button-dir: +.. _typo3-fluid-form-button-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-button-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-button-id: +.. _typo3-fluid-form-button-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-button-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-button-lang: +.. _typo3-fluid-form-button-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-button-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-button-style: +.. _typo3-fluid-form-button-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-button-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-button-title: +.. _typo3-fluid-form-button-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-button-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-button-accesskey: +.. _typo3-fluid-form-button-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-button-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-button-tabindex: +.. _typo3-fluid-form-button-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-button-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-button-onclick: +.. _typo3-fluid-form-button-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-button-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-form-button-type: +.. _typo3-fluid-form-button-type_argument: type ---- -:aspect:`DataType` - string - -:aspect:`Default` - 'submit' +.. confval:: type + :name: typo3-fluid-form-button-type + :type: string + :Default: 'submit' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the type of button (e.g. "button", "reset" or "submit") + Specifies the type of button (e.g. "button", "reset" or "submit") diff --git a/Documentation/typo3/fluid/latest/Form/Checkbox.rst b/Documentation/typo3/fluid/latest/Form/Checkbox.rst index 9eb433a..17ce6a9 100644 --- a/Documentation/typo3/fluid/latest/Form/Checkbox.rst +++ b/Documentation/typo3/fluid/latest/Form/Checkbox.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php :navigation-title: form.checkbox .. include:: /Includes.rst.txt .. _typo3-fluid-form-checkbox: ============================================ -form.checkbox ViewHelper `` +Form.checkbox ViewHelper `` ============================================ - ViewHelper which creates a simple checkbox :html:``. Examples @@ -50,259 +53,249 @@ Output:: Depending on property ``interests``. +.. _typo3-fluid-form-checkbox_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CheckboxViewHelper.php (GitHub) `__. .. _typo3-fluid-form-checkbox_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-checkbox-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-form-checkbox-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-checkbox-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-checkbox-data: +.. _typo3-fluid-form-checkbox-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-checkbox-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-checkbox-aria: +.. _typo3-fluid-form-checkbox-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-checkbox-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-checkbox-name: +.. _typo3-fluid-form-checkbox-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-checkbox-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-checkbox-value: +.. _typo3-fluid-form-checkbox-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-form-checkbox-value + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Value of input tag. Required for checkboxes + Value of input tag. Required for checkboxes -.. _typo3-fluid-form-checkbox-property: +.. _typo3-fluid-form-checkbox-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-checkbox-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-checkbox-disabled: +.. _typo3-fluid-form-checkbox-disabled_argument: disabled -------- -:aspect:`DataType` - string +.. confval:: disabled + :name: typo3-fluid-form-checkbox-disabled + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be disabled when the page loads + Specifies that the input element should be disabled when the page loads -.. _typo3-fluid-form-checkbox-errorclass: +.. _typo3-fluid-form-checkbox-errorclass_argument: errorClass ---------- -:aspect:`DataType` - string - -:aspect:`Default` - 'f3-form-error' +.. confval:: errorClass + :name: typo3-fluid-form-checkbox-errorclass + :type: string + :Default: 'f3-form-error' + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class to set if there are errors for this ViewHelper + CSS class to set if there are errors for this ViewHelper -.. _typo3-fluid-form-checkbox-class: +.. _typo3-fluid-form-checkbox-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-checkbox-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-checkbox-dir: +.. _typo3-fluid-form-checkbox-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-checkbox-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-checkbox-id: +.. _typo3-fluid-form-checkbox-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-checkbox-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-checkbox-lang: +.. _typo3-fluid-form-checkbox-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-checkbox-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-checkbox-style: +.. _typo3-fluid-form-checkbox-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-checkbox-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-checkbox-title: +.. _typo3-fluid-form-checkbox-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-checkbox-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-checkbox-accesskey: +.. _typo3-fluid-form-checkbox-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-checkbox-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-checkbox-tabindex: +.. _typo3-fluid-form-checkbox-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-checkbox-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-checkbox-onclick: +.. _typo3-fluid-form-checkbox-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-checkbox-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-form-checkbox-checked: +.. _typo3-fluid-form-checkbox-checked_argument: checked ------- -:aspect:`DataType` - boolean +.. confval:: checked + :name: typo3-fluid-form-checkbox-checked + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be preselected + Specifies that the input element should be preselected -.. _typo3-fluid-form-checkbox-multiple: +.. _typo3-fluid-form-checkbox-multiple_argument: multiple -------- -:aspect:`DataType` - boolean +.. confval:: multiple + :name: typo3-fluid-form-checkbox-multiple + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies whether this checkbox belongs to a multivalue (is part of a checkbox group) + Specifies whether this checkbox belongs to a multivalue (is part of a checkbox group) diff --git a/Documentation/typo3/fluid/latest/Form/CountrySelect.rst b/Documentation/typo3/fluid/latest/Form/CountrySelect.rst index bbfb87c..32b69db 100644 --- a/Documentation/typo3/fluid/latest/Form/CountrySelect.rst +++ b/Documentation/typo3/fluid/latest/Form/CountrySelect.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/CountrySelectViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/CountrySelectViewHelper.php :navigation-title: form.countrySelect .. include:: /Includes.rst.txt .. _typo3-fluid-form-countryselect: ====================================================== -form.countrySelect ViewHelper `` +Form.countrySelect ViewHelper `` ====================================================== - Renders a :html:` site attribute + Size of select field, a numeric value to show the amount of items to be visible at the same time - equivalent to HTML ` tag. Examples @@ -24,220 +27,213 @@ Output:: You can also use the "property" attribute if you have bound an object to the form. See :ref:` ` for more documentation. +.. _typo3-fluid-form-hidden_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `HiddenViewHelper.php (GitHub) `__. .. _typo3-fluid-form-hidden_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-hidden-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-form-hidden-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-hidden-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-hidden-data: +.. _typo3-fluid-form-hidden-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-hidden-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-hidden-aria: +.. _typo3-fluid-form-hidden-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-hidden-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-hidden-name: +.. _typo3-fluid-form-hidden-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-hidden-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-hidden-value: +.. _typo3-fluid-form-hidden-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-form-hidden-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value of input tag + Value of input tag -.. _typo3-fluid-form-hidden-property: +.. _typo3-fluid-form-hidden-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-hidden-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-hidden-class: +.. _typo3-fluid-form-hidden-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-hidden-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-hidden-dir: +.. _typo3-fluid-form-hidden-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-hidden-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-hidden-id: +.. _typo3-fluid-form-hidden-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-hidden-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-hidden-lang: +.. _typo3-fluid-form-hidden-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-hidden-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-hidden-style: +.. _typo3-fluid-form-hidden-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-hidden-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-hidden-title: +.. _typo3-fluid-form-hidden-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-hidden-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-hidden-accesskey: +.. _typo3-fluid-form-hidden-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-hidden-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-hidden-tabindex: +.. _typo3-fluid-form-hidden-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-hidden-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-hidden-onclick: +.. _typo3-fluid-form-hidden-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-hidden-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-form-hidden-respectsubmitteddatavalue: +.. _typo3-fluid-form-hidden-respectsubmitteddatavalue_argument: respectSubmittedDataValue ------------------------- -:aspect:`DataType` - boolean - -:aspect:`Default` - true +.. confval:: respectSubmittedDataValue + :name: typo3-fluid-form-hidden-respectsubmitteddatavalue + :type: boolean + :Default: true + :required: false -:aspect:`Required` - false -:aspect:`Description` - Enable or disable the usage of the submitted values + Enable or disable the usage of the submitted values diff --git a/Documentation/typo3/fluid/latest/Form/Password.rst b/Documentation/typo3/fluid/latest/Form/Password.rst index 6e327f0..fdc1fa5 100644 --- a/Documentation/typo3/fluid/latest/Form/Password.rst +++ b/Documentation/typo3/fluid/latest/Form/Password.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php :navigation-title: form.password .. include:: /Includes.rst.txt .. _typo3-fluid-form-password: ============================================ -form.password ViewHelper `` +Form.password ViewHelper `` ============================================ - ViewHelper which creates a simple Password Text Box :html:``. Examples @@ -21,298 +24,285 @@ Output:: +.. _typo3-fluid-form-password_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `PasswordViewHelper.php (GitHub) `__. .. _typo3-fluid-form-password_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-password-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-form-password-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-password-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-password-data: +.. _typo3-fluid-form-password-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-password-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-password-aria: +.. _typo3-fluid-form-password-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-password-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-password-name: +.. _typo3-fluid-form-password-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-password-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-password-value: +.. _typo3-fluid-form-password-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-form-password-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value of input tag + Value of input tag -.. _typo3-fluid-form-password-property: +.. _typo3-fluid-form-password-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-password-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-password-disabled: +.. _typo3-fluid-form-password-disabled_argument: disabled -------- -:aspect:`DataType` - string +.. confval:: disabled + :name: typo3-fluid-form-password-disabled + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be disabled when the page loads + Specifies that the input element should be disabled when the page loads -.. _typo3-fluid-form-password-maxlength: +.. _typo3-fluid-form-password-maxlength_argument: maxlength --------- -:aspect:`DataType` - mixed +.. confval:: maxlength + :name: typo3-fluid-form-password-maxlength + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The maxlength attribute of the input field (will not be validated) + The maxlength attribute of the input field (will not be validated) -.. _typo3-fluid-form-password-placeholder: +.. _typo3-fluid-form-password-placeholder_argument: placeholder ----------- -:aspect:`DataType` - string +.. confval:: placeholder + :name: typo3-fluid-form-password-placeholder + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The placeholder of the textfield + The placeholder of the textfield -.. _typo3-fluid-form-password-readonly: +.. _typo3-fluid-form-password-readonly_argument: readonly -------- -:aspect:`DataType` - string +.. confval:: readonly + :name: typo3-fluid-form-password-readonly + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The readonly attribute of the input field + The readonly attribute of the input field -.. _typo3-fluid-form-password-autocomplete: +.. _typo3-fluid-form-password-autocomplete_argument: autocomplete ------------ -:aspect:`DataType` - string +.. confval:: autocomplete + :name: typo3-fluid-form-password-autocomplete + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specify the autocomplete behaviour for password managers + Specify the autocomplete behaviour for password managers -.. _typo3-fluid-form-password-size: +.. _typo3-fluid-form-password-size_argument: size ---- -:aspect:`DataType` - mixed +.. confval:: size + :name: typo3-fluid-form-password-size + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The size of the input field + The size of the input field -.. _typo3-fluid-form-password-errorclass: +.. _typo3-fluid-form-password-errorclass_argument: errorClass ---------- -:aspect:`DataType` - string - -:aspect:`Default` - 'f3-form-error' +.. confval:: errorClass + :name: typo3-fluid-form-password-errorclass + :type: string + :Default: 'f3-form-error' + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class to set if there are errors for this ViewHelper + CSS class to set if there are errors for this ViewHelper -.. _typo3-fluid-form-password-class: +.. _typo3-fluid-form-password-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-password-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-password-dir: +.. _typo3-fluid-form-password-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-password-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-password-id: +.. _typo3-fluid-form-password-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-password-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-password-lang: +.. _typo3-fluid-form-password-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-password-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-password-style: +.. _typo3-fluid-form-password-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-password-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-password-title: +.. _typo3-fluid-form-password-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-password-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-password-accesskey: +.. _typo3-fluid-form-password-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-password-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-password-tabindex: +.. _typo3-fluid-form-password-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-password-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-password-onclick: +.. _typo3-fluid-form-password-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-password-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event diff --git a/Documentation/typo3/fluid/latest/Form/Radio.rst b/Documentation/typo3/fluid/latest/Form/Radio.rst index f93fb09..fd086ba 100644 --- a/Documentation/typo3/fluid/latest/Form/Radio.rst +++ b/Documentation/typo3/fluid/latest/Form/Radio.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/RadioViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/RadioViewHelper.php :navigation-title: form.radio .. include:: /Includes.rst.txt .. _typo3-fluid-form-radio: ====================================== -form.radio ViewHelper `` +Form.radio ViewHelper `` ====================================== - ViewHelper which creates a simple radio button :html:``. Examples @@ -52,246 +55,237 @@ Output:: Depending on property ``newsletter``. +.. _typo3-fluid-form-radio_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `RadioViewHelper.php (GitHub) `__. .. _typo3-fluid-form-radio_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-radio-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-form-radio-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-radio-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-radio-data: +.. _typo3-fluid-form-radio-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-radio-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-radio-aria: +.. _typo3-fluid-form-radio-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-radio-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-radio-name: +.. _typo3-fluid-form-radio-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-radio-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-radio-value: +.. _typo3-fluid-form-radio-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-form-radio-value + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Value of input tag. Required for radio buttons + Value of input tag. Required for radio buttons -.. _typo3-fluid-form-radio-property: +.. _typo3-fluid-form-radio-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-radio-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-radio-errorclass: +.. _typo3-fluid-form-radio-errorclass_argument: errorClass ---------- -:aspect:`DataType` - string - -:aspect:`Default` - 'f3-form-error' +.. confval:: errorClass + :name: typo3-fluid-form-radio-errorclass + :type: string + :Default: 'f3-form-error' + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class to set if there are errors for this ViewHelper + CSS class to set if there are errors for this ViewHelper -.. _typo3-fluid-form-radio-checked: +.. _typo3-fluid-form-radio-checked_argument: checked ------- -:aspect:`DataType` - boolean +.. confval:: checked + :name: typo3-fluid-form-radio-checked + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be preselected + Specifies that the input element should be preselected -.. _typo3-fluid-form-radio-class: +.. _typo3-fluid-form-radio-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-radio-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-radio-dir: +.. _typo3-fluid-form-radio-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-radio-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-radio-id: +.. _typo3-fluid-form-radio-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-radio-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-radio-lang: +.. _typo3-fluid-form-radio-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-radio-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-radio-style: +.. _typo3-fluid-form-radio-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-radio-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-radio-title: +.. _typo3-fluid-form-radio-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-radio-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-radio-accesskey: +.. _typo3-fluid-form-radio-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-radio-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-radio-tabindex: +.. _typo3-fluid-form-radio-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-radio-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-radio-onclick: +.. _typo3-fluid-form-radio-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-radio-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-form-radio-disabled: +.. _typo3-fluid-form-radio-disabled_argument: disabled -------- -:aspect:`DataType` - string +.. confval:: disabled + :name: typo3-fluid-form-radio-disabled + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be disabled when the page loads + Specifies that the input element should be disabled when the page loads diff --git a/Documentation/typo3/fluid/latest/Form/Select.rst b/Documentation/typo3/fluid/latest/Form/Select.rst index 6025f98..dedeb2d 100644 --- a/Documentation/typo3/fluid/latest/Form/Select.rst +++ b/Documentation/typo3/fluid/latest/Form/Select.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/SelectViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/SelectViewHelper.php :navigation-title: form.select .. include:: /Includes.rst.txt .. _typo3-fluid-form-select: ======================================== -form.select ViewHelper `` +Form.select ViewHelper `` ======================================== - This ViewHelper generates a :html:` site attribute + Size of select field, a numeric value to show the amount of items to be visible at the same time - equivalent to HTML +.. _typo3-fluid-form-submit_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `SubmitViewHelper.php (GitHub) `__. .. _typo3-fluid-form-submit_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-form-submit-additionalattributes: +.. _typo3-fluid-form-submit-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-submit-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-submit-data: +.. _typo3-fluid-form-submit-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-submit-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-submit-aria: +.. _typo3-fluid-form-submit-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-submit-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-submit-name: +.. _typo3-fluid-form-submit-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-submit-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-submit-value: +.. _typo3-fluid-form-submit-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-form-submit-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value of input tag + Value of input tag -.. _typo3-fluid-form-submit-property: +.. _typo3-fluid-form-submit-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-submit-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-submit-disabled: +.. _typo3-fluid-form-submit-disabled_argument: disabled -------- -:aspect:`DataType` - string +.. confval:: disabled + :name: typo3-fluid-form-submit-disabled + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be disabled when the page loads + Specifies that the input element should be disabled when the page loads -.. _typo3-fluid-form-submit-class: +.. _typo3-fluid-form-submit-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-submit-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-submit-dir: +.. _typo3-fluid-form-submit-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-submit-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-submit-id: +.. _typo3-fluid-form-submit-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-submit-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-submit-lang: +.. _typo3-fluid-form-submit-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-submit-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-submit-style: +.. _typo3-fluid-form-submit-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-submit-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-submit-title: +.. _typo3-fluid-form-submit-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-submit-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-submit-accesskey: +.. _typo3-fluid-form-submit-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-submit-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-submit-tabindex: +.. _typo3-fluid-form-submit-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-submit-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-submit-onclick: +.. _typo3-fluid-form-submit-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-submit-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event diff --git a/Documentation/typo3/fluid/latest/Form/Textarea.rst b/Documentation/typo3/fluid/latest/Form/Textarea.rst index 867ce25..ef85244 100644 --- a/Documentation/typo3/fluid/latest/Form/Textarea.rst +++ b/Documentation/typo3/fluid/latest/Form/Textarea.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/TextareaViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/TextareaViewHelper.php :navigation-title: form.textarea .. include:: /Includes.rst.txt .. _typo3-fluid-form-textarea: ============================================ -form.textarea ViewHelper `` +Form.textarea ViewHelper `` ============================================ - Generates an :html:` +.. _typo3-fluid-form-textarea_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `TextareaViewHelper.php (GitHub) `__. .. _typo3-fluid-form-textarea_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-textarea-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-form-textarea-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-textarea-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-textarea-data: +.. _typo3-fluid-form-textarea-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-textarea-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-textarea-aria: +.. _typo3-fluid-form-textarea-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-textarea-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-textarea-name: +.. _typo3-fluid-form-textarea-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-textarea-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-textarea-value: +.. _typo3-fluid-form-textarea-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-form-textarea-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value of input tag + Value of input tag -.. _typo3-fluid-form-textarea-property: +.. _typo3-fluid-form-textarea-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-textarea-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-textarea-autofocus: +.. _typo3-fluid-form-textarea-autofocus_argument: autofocus --------- -:aspect:`DataType` - string +.. confval:: autofocus + :name: typo3-fluid-form-textarea-autofocus + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that a text area should automatically get focus when the page loads + Specifies that a text area should automatically get focus when the page loads -.. _typo3-fluid-form-textarea-rows: +.. _typo3-fluid-form-textarea-rows_argument: rows ---- -:aspect:`DataType` - mixed +.. confval:: rows + :name: typo3-fluid-form-textarea-rows + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The number of rows of a text area + The number of rows of a text area -.. _typo3-fluid-form-textarea-cols: +.. _typo3-fluid-form-textarea-cols_argument: cols ---- -:aspect:`DataType` - mixed +.. confval:: cols + :name: typo3-fluid-form-textarea-cols + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The number of columns of a text area + The number of columns of a text area -.. _typo3-fluid-form-textarea-disabled: +.. _typo3-fluid-form-textarea-disabled_argument: disabled -------- -:aspect:`DataType` - string +.. confval:: disabled + :name: typo3-fluid-form-textarea-disabled + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be disabled when the page loads + Specifies that the input element should be disabled when the page loads -.. _typo3-fluid-form-textarea-placeholder: +.. _typo3-fluid-form-textarea-placeholder_argument: placeholder ----------- -:aspect:`DataType` - string +.. confval:: placeholder + :name: typo3-fluid-form-textarea-placeholder + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The placeholder of the textarea + The placeholder of the textarea -.. _typo3-fluid-form-textarea-errorclass: +.. _typo3-fluid-form-textarea-errorclass_argument: errorClass ---------- -:aspect:`DataType` - string - -:aspect:`Default` - 'f3-form-error' +.. confval:: errorClass + :name: typo3-fluid-form-textarea-errorclass + :type: string + :Default: 'f3-form-error' + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class to set if there are errors for this ViewHelper + CSS class to set if there are errors for this ViewHelper -.. _typo3-fluid-form-textarea-readonly: +.. _typo3-fluid-form-textarea-readonly_argument: readonly -------- -:aspect:`DataType` - string +.. confval:: readonly + :name: typo3-fluid-form-textarea-readonly + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The readonly attribute of the textarea + The readonly attribute of the textarea -.. _typo3-fluid-form-textarea-required: +.. _typo3-fluid-form-textarea-required_argument: required -------- -:aspect:`DataType` - boolean +.. confval:: required + :name: typo3-fluid-form-textarea-required + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies whether the textarea is required + Specifies whether the textarea is required -.. _typo3-fluid-form-textarea-class: +.. _typo3-fluid-form-textarea-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-textarea-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-textarea-dir: +.. _typo3-fluid-form-textarea-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-textarea-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-textarea-id: +.. _typo3-fluid-form-textarea-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-textarea-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-textarea-lang: +.. _typo3-fluid-form-textarea-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-textarea-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-textarea-style: +.. _typo3-fluid-form-textarea-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-textarea-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-textarea-title: +.. _typo3-fluid-form-textarea-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-textarea-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-textarea-accesskey: +.. _typo3-fluid-form-textarea-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-textarea-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-textarea-tabindex: +.. _typo3-fluid-form-textarea-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-textarea-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-textarea-onclick: +.. _typo3-fluid-form-textarea-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-textarea-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event diff --git a/Documentation/typo3/fluid/latest/Form/Textfield.rst b/Documentation/typo3/fluid/latest/Form/Textfield.rst index 04d6910..7f02cc6 100644 --- a/Documentation/typo3/fluid/latest/Form/Textfield.rst +++ b/Documentation/typo3/fluid/latest/Form/Textfield.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/TextfieldViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/TextfieldViewHelper.php :navigation-title: form.textfield .. include:: /Includes.rst.txt .. _typo3-fluid-form-textfield: ============================================== -form.textfield ViewHelper `` +Form.textfield ViewHelper `` ============================================== - ViewHelper which creates a text field :html:``. Examples @@ -21,340 +24,322 @@ Output:: +.. _typo3-fluid-form-textfield_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `TextfieldViewHelper.php (GitHub) `__. .. _typo3-fluid-form-textfield_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-textfield-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-form-textfield-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-textfield-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-textfield-data: +.. _typo3-fluid-form-textfield-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-textfield-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-textfield-aria: +.. _typo3-fluid-form-textfield-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-textfield-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-textfield-name: +.. _typo3-fluid-form-textfield-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-textfield-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-textfield-value: +.. _typo3-fluid-form-textfield-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-form-textfield-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value of input tag + Value of input tag -.. _typo3-fluid-form-textfield-property: +.. _typo3-fluid-form-textfield-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-textfield-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-textfield-autofocus: +.. _typo3-fluid-form-textfield-autofocus_argument: autofocus --------- -:aspect:`DataType` - string +.. confval:: autofocus + :name: typo3-fluid-form-textfield-autofocus + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that an input should automatically get focus when the page loads + Specifies that an input should automatically get focus when the page loads -.. _typo3-fluid-form-textfield-disabled: +.. _typo3-fluid-form-textfield-disabled_argument: disabled -------- -:aspect:`DataType` - string +.. confval:: disabled + :name: typo3-fluid-form-textfield-disabled + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be disabled when the page loads + Specifies that the input element should be disabled when the page loads -.. _typo3-fluid-form-textfield-maxlength: +.. _typo3-fluid-form-textfield-maxlength_argument: maxlength --------- -:aspect:`DataType` - mixed +.. confval:: maxlength + :name: typo3-fluid-form-textfield-maxlength + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The maxlength attribute of the input field (will not be validated) + The maxlength attribute of the input field (will not be validated) -.. _typo3-fluid-form-textfield-readonly: +.. _typo3-fluid-form-textfield-readonly_argument: readonly -------- -:aspect:`DataType` - string +.. confval:: readonly + :name: typo3-fluid-form-textfield-readonly + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The readonly attribute of the input field + The readonly attribute of the input field -.. _typo3-fluid-form-textfield-size: +.. _typo3-fluid-form-textfield-size_argument: size ---- -:aspect:`DataType` - mixed +.. confval:: size + :name: typo3-fluid-form-textfield-size + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The size of the input field + The size of the input field -.. _typo3-fluid-form-textfield-placeholder: +.. _typo3-fluid-form-textfield-placeholder_argument: placeholder ----------- -:aspect:`DataType` - string +.. confval:: placeholder + :name: typo3-fluid-form-textfield-placeholder + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The placeholder of the textfield + The placeholder of the textfield -.. _typo3-fluid-form-textfield-pattern: +.. _typo3-fluid-form-textfield-pattern_argument: pattern ------- -:aspect:`DataType` - string +.. confval:: pattern + :name: typo3-fluid-form-textfield-pattern + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - HTML5 validation pattern + HTML5 validation pattern -.. _typo3-fluid-form-textfield-errorclass: +.. _typo3-fluid-form-textfield-errorclass_argument: errorClass ---------- -:aspect:`DataType` - string +.. confval:: errorClass + :name: typo3-fluid-form-textfield-errorclass + :type: string + :Default: 'f3-form-error' + :required: false -:aspect:`Default` - 'f3-form-error' + CSS class to set if there are errors for this ViewHelper -:aspect:`Required` - false -:aspect:`Description` - CSS class to set if there are errors for this ViewHelper - -.. _typo3-fluid-form-textfield-class: +.. _typo3-fluid-form-textfield-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-textfield-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-textfield-dir: +.. _typo3-fluid-form-textfield-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-textfield-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-textfield-id: +.. _typo3-fluid-form-textfield-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-textfield-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-textfield-lang: +.. _typo3-fluid-form-textfield-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-textfield-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-textfield-style: +.. _typo3-fluid-form-textfield-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-textfield-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-textfield-title: +.. _typo3-fluid-form-textfield-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-textfield-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-textfield-accesskey: +.. _typo3-fluid-form-textfield-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-textfield-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-textfield-tabindex: +.. _typo3-fluid-form-textfield-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-textfield-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-textfield-onclick: +.. _typo3-fluid-form-textfield-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-textfield-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-form-textfield-required: +.. _typo3-fluid-form-textfield-required_argument: required -------- -:aspect:`DataType` - boolean +.. confval:: required + :name: typo3-fluid-form-textfield-required + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If the field is required or not + If the field is required or not -.. _typo3-fluid-form-textfield-type: +.. _typo3-fluid-form-textfield-type_argument: type ---- -:aspect:`DataType` - string - -:aspect:`Default` - 'text' +.. confval:: type + :name: typo3-fluid-form-textfield-type + :type: string + :Default: 'text' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The field type, e.g. "text", "email", "url" etc. + The field type, e.g. "text", "email", "url" etc. diff --git a/Documentation/typo3/fluid/latest/Form/Upload.rst b/Documentation/typo3/fluid/latest/Form/Upload.rst index 41fae69..669a40b 100644 --- a/Documentation/typo3/fluid/latest/Form/Upload.rst +++ b/Documentation/typo3/fluid/latest/Form/Upload.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/UploadViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/UploadViewHelper.php :navigation-title: form.upload .. include:: /Includes.rst.txt .. _typo3-fluid-form-upload: ======================================== -form.upload ViewHelper `` +Form.upload ViewHelper `` ======================================== - A ViewHelper which generates an :html:`` HTML element. Make sure to set ``enctype="multipart/form-data"`` on the form! @@ -22,259 +25,249 @@ Output:: +.. _typo3-fluid-form-upload_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `UploadViewHelper.php (GitHub) `__. .. _typo3-fluid-form-upload_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-upload-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-form-upload-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-form-upload-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-form-upload-data: +.. _typo3-fluid-form-upload-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-form-upload-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-form-upload-aria: +.. _typo3-fluid-form-upload-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-form-upload-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-form-upload-name: +.. _typo3-fluid-form-upload-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-form-upload-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of input tag + Name of input tag -.. _typo3-fluid-form-upload-value: +.. _typo3-fluid-form-upload-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-form-upload-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value of input tag + Value of input tag -.. _typo3-fluid-form-upload-property: +.. _typo3-fluid-form-upload-property_argument: property -------- -:aspect:`DataType` - string +.. confval:: property + :name: typo3-fluid-form-upload-property + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. + Name of Object Property. If used in conjunction with , the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value. -.. _typo3-fluid-form-upload-disabled: +.. _typo3-fluid-form-upload-disabled_argument: disabled -------- -:aspect:`DataType` - string +.. confval:: disabled + :name: typo3-fluid-form-upload-disabled + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the input element should be disabled when the page loads + Specifies that the input element should be disabled when the page loads -.. _typo3-fluid-form-upload-multiple: +.. _typo3-fluid-form-upload-multiple_argument: multiple -------- -:aspect:`DataType` - string +.. confval:: multiple + :name: typo3-fluid-form-upload-multiple + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies that the file input element should allow multiple selection of files + Specifies that the file input element should allow multiple selection of files -.. _typo3-fluid-form-upload-accept: +.. _typo3-fluid-form-upload-accept_argument: accept ------ -:aspect:`DataType` - string +.. confval:: accept + :name: typo3-fluid-form-upload-accept + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the allowed file extensions to upload via comma-separated list, example ".png,.gif" + Specifies the allowed file extensions to upload via comma-separated list, example ".png,.gif" -.. _typo3-fluid-form-upload-errorclass: +.. _typo3-fluid-form-upload-errorclass_argument: errorClass ---------- -:aspect:`DataType` - string - -:aspect:`Default` - 'f3-form-error' +.. confval:: errorClass + :name: typo3-fluid-form-upload-errorclass + :type: string + :Default: 'f3-form-error' + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class to set if there are errors for this ViewHelper + CSS class to set if there are errors for this ViewHelper -.. _typo3-fluid-form-upload-class: +.. _typo3-fluid-form-upload-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-form-upload-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-form-upload-dir: +.. _typo3-fluid-form-upload-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-form-upload-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-form-upload-id: +.. _typo3-fluid-form-upload-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-form-upload-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-form-upload-lang: +.. _typo3-fluid-form-upload-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-form-upload-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-form-upload-style: +.. _typo3-fluid-form-upload-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-form-upload-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-form-upload-title: +.. _typo3-fluid-form-upload-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-form-upload-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-form-upload-accesskey: +.. _typo3-fluid-form-upload-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-form-upload-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-form-upload-tabindex: +.. _typo3-fluid-form-upload-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-form-upload-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-form-upload-onclick: +.. _typo3-fluid-form-upload-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-form-upload-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event diff --git a/Documentation/typo3/fluid/latest/Form/ValidationResults.rst b/Documentation/typo3/fluid/latest/Form/ValidationResults.rst index c4fe367..148d395 100644 --- a/Documentation/typo3/fluid/latest/Form/ValidationResults.rst +++ b/Documentation/typo3/fluid/latest/Form/ValidationResults.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/ValidationResultsViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Form/ValidationResultsViewHelper.php :navigation-title: form.validationResults .. include:: /Includes.rst.txt .. _typo3-fluid-form-validationresults: ============================================================== -form.validationResults ViewHelper `` +Form.validationResults ViewHelper `` ============================================================== - Validation results ViewHelper Examples @@ -55,38 +58,45 @@ Output::
  • 1234567890: Some error message
    • +.. _typo3-fluid-form-validationresults_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ValidationResultsViewHelper.php (GitHub) `__. .. _typo3-fluid-form-validationresults_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-form-validationresults-for: +.. contents:: + :local: + + +.. _typo3-fluid-form-validationresults-for_argument: for --- -:aspect:`DataType` - string +.. confval:: for + :name: typo3-fluid-form-validationresults-for + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The name of the error name (e.g. argument name or property name). This can also be a property path (like blog.title), and will then only display the validation errors of that property. + The name of the error name (e.g. argument name or property name). This can also be a property path (like blog.title), and will then only display the validation errors of that property. -.. _typo3-fluid-form-validationresults-as: +.. _typo3-fluid-form-validationresults-as_argument: as -- -:aspect:`DataType` - string - -:aspect:`Default` - 'validationResults' +.. confval:: as + :name: typo3-fluid-form-validationresults-as + :type: string + :Default: 'validationResults' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The name of the variable to store the current error + The name of the variable to store the current error diff --git a/Documentation/typo3/fluid/latest/Format/Bytes.rst b/Documentation/typo3/fluid/latest/Format/Bytes.rst index 55d91c0..2cde40a 100644 --- a/Documentation/typo3/fluid/latest/Format/Bytes.rst +++ b/Documentation/typo3/fluid/latest/Format/Bytes.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/BytesViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/BytesViewHelper.php :navigation-title: format.bytes .. include:: /Includes.rst.txt .. _typo3-fluid-format-bytes: ========================================== -format.bytes ViewHelper `` +Format.bytes ViewHelper `` ========================================== - Formats an integer with a byte count into human readable form. Examples @@ -45,80 +48,82 @@ Custom units ``123 KB`` Depending on the value of ``{fileSize}``. +.. _typo3-fluid-format-bytes_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `BytesViewHelper.php (GitHub) `__. .. _typo3-fluid-format-bytes_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-format-bytes-value: +.. contents:: + :local: + + +.. _typo3-fluid-format-bytes-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-format-bytes-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The incoming data to convert, or NULL if VH children should be used + The incoming data to convert, or NULL if VH children should be used -.. _typo3-fluid-format-bytes-decimals: +.. _typo3-fluid-format-bytes-decimals_argument: decimals -------- -:aspect:`DataType` - mixed +.. confval:: decimals + :name: typo3-fluid-format-bytes-decimals + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The number of digits after the decimal point + The number of digits after the decimal point -.. _typo3-fluid-format-bytes-decimalseparator: +.. _typo3-fluid-format-bytes-decimalseparator_argument: decimalSeparator ---------------- -:aspect:`DataType` - string +.. confval:: decimalSeparator + :name: typo3-fluid-format-bytes-decimalseparator + :type: string + :Default: '.' + :required: false -:aspect:`Default` - '.' + The decimal point character -:aspect:`Required` - false -:aspect:`Description` - The decimal point character - -.. _typo3-fluid-format-bytes-thousandsseparator: +.. _typo3-fluid-format-bytes-thousandsseparator_argument: thousandsSeparator ------------------ -:aspect:`DataType` - string - -:aspect:`Default` - ',' +.. confval:: thousandsSeparator + :name: typo3-fluid-format-bytes-thousandsseparator + :type: string + :Default: ',' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The character for grouping the thousand digits + The character for grouping the thousand digits -.. _typo3-fluid-format-bytes-units: +.. _typo3-fluid-format-bytes-units_argument: units ----- -:aspect:`DataType` - string +.. confval:: units + :name: typo3-fluid-format-bytes-units + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Comma separated list of available units, default is LocalizationUtility::translate('viewhelper.format.bytes.units', 'fluid') + Comma separated list of available units, default is LocalizationUtility::translate('viewhelper.format.bytes.units', 'fluid') diff --git a/Documentation/typo3/fluid/latest/Format/Case.rst b/Documentation/typo3/fluid/latest/Format/Case.rst index b17a358..701522d 100644 --- a/Documentation/typo3/fluid/latest/Format/Case.rst +++ b/Documentation/typo3/fluid/latest/Format/Case.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/CaseViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/CaseViewHelper.php :navigation-title: format.case .. include:: /Includes.rst.txt .. _typo3-fluid-format-case: ======================================== -format.case ViewHelper `` +Format.case ViewHelper `` ======================================== - Modifies the case of an input string to upper- or lowercase or capitalization. The default transformation will be uppercase as in `mb_convert_case`_. @@ -58,38 +61,45 @@ Output:: SomeString +.. _typo3-fluid-format-case_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CaseViewHelper.php (GitHub) `__. .. _typo3-fluid-format-case_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-format-case-value: +.. contents:: + :local: + + +.. _typo3-fluid-format-case-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-format-case-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The input value. If not given, the evaluated child nodes will be used. + The input value. If not given, the evaluated child nodes will be used. -.. _typo3-fluid-format-case-mode: +.. _typo3-fluid-format-case-mode_argument: mode ---- -:aspect:`DataType` - string - -:aspect:`Default` - 'upper' +.. confval:: mode + :name: typo3-fluid-format-case-mode + :type: string + :Default: 'upper' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The case to apply, must be one of this' CASE_* constants. Defaults to uppercase application. + The case to apply, must be one of this' CASE_* constants. Defaults to uppercase application. diff --git a/Documentation/typo3/fluid/latest/Format/Crop.rst b/Documentation/typo3/fluid/latest/Format/Crop.rst index 2205d99..1a3b1fa 100644 --- a/Documentation/typo3/fluid/latest/Format/Crop.rst +++ b/Documentation/typo3/fluid/latest/Format/Crop.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/CropViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/CropViewHelper.php :navigation-title: format.crop .. include:: /Includes.rst.txt .. _typo3-fluid-format-crop: ======================================== -format.crop ViewHelper `` +Format.crop ViewHelper `` ======================================== - Use this ViewHelper to crop the text between its opening and closing tags. Whitespace within the f:format.crop element will be considered as characters. @@ -72,70 +75,71 @@ Inline notation ``someLongText cropped after 10 characters`` Depending on the value of ``{someLongText}``. +.. _typo3-fluid-format-crop_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CropViewHelper.php (GitHub) `__. .. _typo3-fluid-format-crop_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: -.. _typo3-fluid-format-crop-maxcharacters: + +.. _typo3-fluid-format-crop-maxcharacters_argument: maxCharacters ------------- -:aspect:`DataType` - mixed +.. confval:: maxCharacters + :name: typo3-fluid-format-crop-maxcharacters + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Place where to truncate the string + Place where to truncate the string -.. _typo3-fluid-format-crop-append: +.. _typo3-fluid-format-crop-append_argument: append ------ -:aspect:`DataType` - string - -:aspect:`Default` - '…' +.. confval:: append + :name: typo3-fluid-format-crop-append + :type: string + :Default: '…' + :required: false -:aspect:`Required` - false -:aspect:`Description` - What to append, if truncation happened + What to append, if truncation happened -.. _typo3-fluid-format-crop-respectwordboundaries: +.. _typo3-fluid-format-crop-respectwordboundaries_argument: respectWordBoundaries --------------------- -:aspect:`DataType` - boolean +.. confval:: respectWordBoundaries + :name: typo3-fluid-format-crop-respectwordboundaries + :type: boolean + :Default: true + :required: false -:aspect:`Default` - true + If TRUE and division is in the middle of a word, the remains of that word is removed. -:aspect:`Required` - false -:aspect:`Description` - If TRUE and division is in the middle of a word, the remains of that word is removed. - -.. _typo3-fluid-format-crop-respecthtml: +.. _typo3-fluid-format-crop-respecthtml_argument: respectHtml ----------- -:aspect:`DataType` - boolean - -:aspect:`Default` - true +.. confval:: respectHtml + :name: typo3-fluid-format-crop-respecthtml + :type: boolean + :Default: true + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE the cropped string will respect HTML tags and entities. Technically that means, that cropHTML() is called rather than crop() + If TRUE the cropped string will respect HTML tags and entities. Technically that means, that cropHTML() is called rather than crop() diff --git a/Documentation/typo3/fluid/latest/Format/Currency.rst b/Documentation/typo3/fluid/latest/Format/Currency.rst index 8d27095..3f21890 100644 --- a/Documentation/typo3/fluid/latest/Format/Currency.rst +++ b/Documentation/typo3/fluid/latest/Format/Currency.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/CurrencyViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/CurrencyViewHelper.php :navigation-title: format.currency .. include:: /Includes.rst.txt .. _typo3-fluid-format-currency: ================================================ -format.currency ViewHelper `` +Format.currency ViewHelper `` ================================================ - Formats a given float to a currency representation. Examples @@ -63,112 +66,108 @@ Output:: 123,- +.. _typo3-fluid-format-currency_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CurrencyViewHelper.php (GitHub) `__. .. _typo3-fluid-format-currency_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: -.. _typo3-fluid-format-currency-currencysign: + +.. _typo3-fluid-format-currency-currencysign_argument: currencySign ------------ -:aspect:`DataType` - string +.. confval:: currencySign + :name: typo3-fluid-format-currency-currencysign + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The currency sign, eg $ or . + The currency sign, eg $ or . -.. _typo3-fluid-format-currency-decimalseparator: +.. _typo3-fluid-format-currency-decimalseparator_argument: decimalSeparator ---------------- -:aspect:`DataType` - string - -:aspect:`Default` - ',' +.. confval:: decimalSeparator + :name: typo3-fluid-format-currency-decimalseparator + :type: string + :Default: ',' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The separator for the decimal point. + The separator for the decimal point. -.. _typo3-fluid-format-currency-thousandsseparator: +.. _typo3-fluid-format-currency-thousandsseparator_argument: thousandsSeparator ------------------ -:aspect:`DataType` - string - -:aspect:`Default` - '.' +.. confval:: thousandsSeparator + :name: typo3-fluid-format-currency-thousandsseparator + :type: string + :Default: '.' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The thousands separator. + The thousands separator. -.. _typo3-fluid-format-currency-prependcurrency: +.. _typo3-fluid-format-currency-prependcurrency_argument: prependCurrency --------------- -:aspect:`DataType` - boolean +.. confval:: prependCurrency + :name: typo3-fluid-format-currency-prependcurrency + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Select if the currency sign should be prepended + Select if the currency sign should be prepended -.. _typo3-fluid-format-currency-separatecurrency: +.. _typo3-fluid-format-currency-separatecurrency_argument: separateCurrency ---------------- -:aspect:`DataType` - boolean +.. confval:: separateCurrency + :name: typo3-fluid-format-currency-separatecurrency + :type: boolean + :Default: true + :required: false -:aspect:`Default` - true + Separate the currency sign from the number by a single space, defaults to true due to backwards compatibility -:aspect:`Required` - false -:aspect:`Description` - Separate the currency sign from the number by a single space, defaults to true due to backwards compatibility - -.. _typo3-fluid-format-currency-decimals: +.. _typo3-fluid-format-currency-decimals_argument: decimals -------- -:aspect:`DataType` - mixed - -:aspect:`Default` - 2 +.. confval:: decimals + :name: typo3-fluid-format-currency-decimals + :type: mixed + :Default: 2 + :required: false -:aspect:`Required` - false -:aspect:`Description` - Set decimals places. + Set decimals places. -.. _typo3-fluid-format-currency-usedash: +.. _typo3-fluid-format-currency-usedash_argument: useDash ------- -:aspect:`DataType` - boolean +.. confval:: useDash + :name: typo3-fluid-format-currency-usedash + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Use the dash instead of decimal 00 + Use the dash instead of decimal 00 diff --git a/Documentation/typo3/fluid/latest/Format/Date.rst b/Documentation/typo3/fluid/latest/Format/Date.rst index 1af3e35..a1d39af 100644 --- a/Documentation/typo3/fluid/latest/Format/Date.rst +++ b/Documentation/typo3/fluid/latest/Format/Date.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/DateViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/DateViewHelper.php :navigation-title: format.date .. include:: /Includes.rst.txt .. _typo3-fluid-format-date: ======================================== -format.date ViewHelper `` +Format.date ViewHelper `` ======================================== - Formats an object implementing :php:`\DateTimeInterface`. Possible date/time formats can be found in the PHP documentation: @@ -106,74 +109,80 @@ Inline notation (2nd variant) ``1980-12-13`` Depending on the value of ``{dateObject}``. +.. _typo3-fluid-format-date_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `DateViewHelper.php (GitHub) `__. .. _typo3-fluid-format-date_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-format-date-date: +.. _typo3-fluid-format-date-date_argument: date ---- -:aspect:`DataType` - mixed +.. confval:: date + :name: typo3-fluid-format-date-date + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Either an object implementing DateTimeInterface or a string that is accepted by DateTime constructor + Either an object implementing DateTimeInterface or a string that is accepted by DateTime constructor -.. _typo3-fluid-format-date-format: +.. _typo3-fluid-format-date-format_argument: format ------ -:aspect:`DataType` - string +.. confval:: format + :name: typo3-fluid-format-date-format + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Format String which is taken to format the Date/Time + Format String which is taken to format the Date/Time -.. _typo3-fluid-format-date-pattern: +.. _typo3-fluid-format-date-pattern_argument: pattern ------- -:aspect:`DataType` - string +.. confval:: pattern + :name: typo3-fluid-format-date-pattern + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Format date based on unicode ICO format pattern given see https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax. If both "pattern" and "format" arguments are given, pattern will be used. + Format date based on unicode ICO format pattern given see https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax. If both "pattern" and "format" arguments are given, pattern will be used. -.. _typo3-fluid-format-date-locale: +.. _typo3-fluid-format-date-locale_argument: locale ------ -:aspect:`DataType` - string +.. confval:: locale + :name: typo3-fluid-format-date-locale + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - A locale format such as "nl-NL" to format the date in a specific locale, if none given, uses the current locale of the current request. Only works when pattern argument is given + A locale format such as "nl-NL" to format the date in a specific locale, if none given, uses the current locale of the current request. Only works when pattern argument is given -.. _typo3-fluid-format-date-base: +.. _typo3-fluid-format-date-base_argument: base ---- -:aspect:`DataType` - mixed +.. confval:: base + :name: typo3-fluid-format-date-base + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - A base time (an object implementing DateTimeInterface or a string) used if $date is a relative date specification. Defaults to current time. + A base time (an object implementing DateTimeInterface or a string) used if $date is a relative date specification. Defaults to current time. diff --git a/Documentation/typo3/fluid/latest/Format/Html.rst b/Documentation/typo3/fluid/latest/Format/Html.rst index 66ffa01..1a91bb7 100644 --- a/Documentation/typo3/fluid/latest/Format/Html.rst +++ b/Documentation/typo3/fluid/latest/Format/Html.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlViewHelper.php :navigation-title: format.html .. include:: /Includes.rst.txt .. _typo3-fluid-format-html: ======================================== -format.html ViewHelper `` +Format.html ViewHelper `` ======================================== - 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 :typoscript:`lib.parseFunc_RTE` is used to parse the string. @@ -96,77 +99,81 @@ Output:: .. _parseFunc: https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/Functions/Parsefunc.html +.. _typo3-fluid-format-html_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `HtmlViewHelper.php (GitHub) `__. .. _typo3-fluid-format-html_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-format-html-parsefunctspath: +.. contents:: + :local: + + +.. _typo3-fluid-format-html-parsefunctspath_argument: parseFuncTSPath --------------- -:aspect:`DataType` - string - -:aspect:`Default` - 'lib.parseFunc_RTE' +.. confval:: parseFuncTSPath + :name: typo3-fluid-format-html-parsefunctspath + :type: string + :Default: 'lib.parseFunc_RTE' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Path to the TypoScript parseFunc setup. + Path to the TypoScript parseFunc setup. -.. _typo3-fluid-format-html-data: +.. _typo3-fluid-format-html-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-format-html-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Initialize the content object with this set of data. Either an array or object. + Initialize the content object with this set of data. Either an array or object. -.. _typo3-fluid-format-html-current: +.. _typo3-fluid-format-html-current_argument: current ------- -:aspect:`DataType` - string +.. confval:: current + :name: typo3-fluid-format-html-current + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Initialize the content object with this value for current property. + Initialize the content object with this value for current property. -.. _typo3-fluid-format-html-currentvaluekey: +.. _typo3-fluid-format-html-currentvaluekey_argument: currentValueKey --------------- -:aspect:`DataType` - string +.. confval:: currentValueKey + :name: typo3-fluid-format-html-currentvaluekey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the value key, used to locate the current value for the content object + Define the value key, used to locate the current value for the content object -.. _typo3-fluid-format-html-table: +.. _typo3-fluid-format-html-table_argument: table ----- -:aspect:`DataType` - string +.. confval:: table + :name: typo3-fluid-format-html-table + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The table name associated with the "data" argument. + The table name associated with the "data" argument. diff --git a/Documentation/typo3/fluid/latest/Format/Htmlentities.rst b/Documentation/typo3/fluid/latest/Format/Htmlentities.rst index 02eb629..792bc94 100644 --- a/Documentation/typo3/fluid/latest/Format/Htmlentities.rst +++ b/Documentation/typo3/fluid/latest/Format/Htmlentities.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesViewHelper.php :navigation-title: format.htmlentities .. include:: /Includes.rst.txt .. _typo3-fluid-format-htmlentities: ======================================================== -format.htmlentities ViewHelper `` +Format.htmlentities ViewHelper `` ======================================================== - Applies :php:`htmlentities()` escaping to a value. See https://www.php.net/manual/function.htmlentities.php. @@ -36,64 +39,69 @@ These will result in: ``&`` ``"`` ``'`` ``<`` ``>``. But encoded as ISO-8859-1. +.. _typo3-fluid-format-htmlentities_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `HtmlentitiesViewHelper.php (GitHub) `__. .. _typo3-fluid-format-htmlentities_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-format-htmlentities-value: +.. contents:: + :local: + + +.. _typo3-fluid-format-htmlentities-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-format-htmlentities-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - String to format + String to format -.. _typo3-fluid-format-htmlentities-keepquotes: +.. _typo3-fluid-format-htmlentities-keepquotes_argument: keepQuotes ---------- -:aspect:`DataType` - boolean +.. confval:: keepQuotes + :name: typo3-fluid-format-htmlentities-keepquotes + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, single and double quotes won't be replaced (sets ENT_NOQUOTES flag). + If TRUE, single and double quotes won't be replaced (sets ENT_NOQUOTES flag). -.. _typo3-fluid-format-htmlentities-encoding: +.. _typo3-fluid-format-htmlentities-encoding_argument: encoding -------- -:aspect:`DataType` - string +.. confval:: encoding + :name: typo3-fluid-format-htmlentities-encoding + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the encoding used when converting characters (Default: UTF-8 + Define the encoding used when converting characters (Default: UTF-8 -.. _typo3-fluid-format-htmlentities-doubleencode: +.. _typo3-fluid-format-htmlentities-doubleencode_argument: doubleEncode ------------ -:aspect:`DataType` - boolean - -:aspect:`Default` - true +.. confval:: doubleEncode + :name: typo3-fluid-format-htmlentities-doubleencode + :type: boolean + :Default: true + :required: false -:aspect:`Required` - false -:aspect:`Description` - If FALSE existing html entities won't be encoded, the default is to convert everything. + If FALSE existing html entities won't be encoded, the default is to convert everything. diff --git a/Documentation/typo3/fluid/latest/Format/HtmlentitiesDecode.rst b/Documentation/typo3/fluid/latest/Format/HtmlentitiesDecode.rst index 2f452a3..b736d80 100644 --- a/Documentation/typo3/fluid/latest/Format/HtmlentitiesDecode.rst +++ b/Documentation/typo3/fluid/latest/Format/HtmlentitiesDecode.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesDecodeViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesDecodeViewHelper.php :navigation-title: format.htmlentitiesDecode .. include:: /Includes.rst.txt .. _typo3-fluid-format-htmlentitiesdecode: ==================================================================== -format.htmlentitiesDecode ViewHelper `` +Format.htmlentitiesDecode ViewHelper `` ==================================================================== - Applies :php:`html_entity_decode()` to a value. See https://www.php.net/html_entity_decode. @@ -36,48 +39,56 @@ These will result in: ``&`` ``"`` ``'`` ``<`` ``>``. But encoded as ISO-8859-1. +.. _typo3-fluid-format-htmlentitiesdecode_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `HtmlentitiesDecodeViewHelper.php (GitHub) `__. .. _typo3-fluid-format-htmlentitiesdecode_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-format-htmlentitiesdecode-value: +.. _typo3-fluid-format-htmlentitiesdecode-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-format-htmlentitiesdecode-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - String to format + String to format -.. _typo3-fluid-format-htmlentitiesdecode-keepquotes: +.. _typo3-fluid-format-htmlentitiesdecode-keepquotes_argument: keepQuotes ---------- -:aspect:`DataType` - boolean +.. confval:: keepQuotes + :name: typo3-fluid-format-htmlentitiesdecode-keepquotes + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, single and double quotes won't be replaced (sets ENT_NOQUOTES flag). + If TRUE, single and double quotes won't be replaced (sets ENT_NOQUOTES flag). -.. _typo3-fluid-format-htmlentitiesdecode-encoding: +.. _typo3-fluid-format-htmlentitiesdecode-encoding_argument: encoding -------- -:aspect:`DataType` - string +.. confval:: encoding + :name: typo3-fluid-format-htmlentitiesdecode-encoding + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the encoding used when converting characters (Default: UTF-8). + Define the encoding used when converting characters (Default: UTF-8). diff --git a/Documentation/typo3/fluid/latest/Format/Json.rst b/Documentation/typo3/fluid/latest/Format/Json.rst index 42941dc..73e0188 100644 --- a/Documentation/typo3/fluid/latest/Format/Json.rst +++ b/Documentation/typo3/fluid/latest/Format/Json.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/JsonViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/JsonViewHelper.php :navigation-title: format.json .. include:: /Includes.rst.txt .. _typo3-fluid-format-json: ======================================== -format.json ViewHelper `` +Format.json ViewHelper `` ======================================== - Wrapper for PHPs :php:`json_encode` function. See https://www.php.net/manual/function.json-encode.php. @@ -42,35 +45,44 @@ Non associative array with forced object ``{"0":"bar","1":"baz"}`` +.. _typo3-fluid-format-json_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `JsonViewHelper.php (GitHub) `__. .. _typo3-fluid-format-json_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-format-json-value: +.. _typo3-fluid-format-json-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3-fluid-format-json-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The incoming data to convert, or null if VH children should be used + The incoming data to convert, or null if VH children should be used -.. _typo3-fluid-format-json-forceobject: +.. _typo3-fluid-format-json-forceobject_argument: forceObject ----------- -:aspect:`DataType` - boolean +.. confval:: forceObject + :name: typo3-fluid-format-json-forceobject + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Outputs an JSON object rather than an array + Outputs an JSON object rather than an array diff --git a/Documentation/typo3/fluid/latest/Format/Nl2br.rst b/Documentation/typo3/fluid/latest/Format/Nl2br.rst index 3583fe0..384e94b 100644 --- a/Documentation/typo3/fluid/latest/Format/Nl2br.rst +++ b/Documentation/typo3/fluid/latest/Format/Nl2br.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/Nl2brViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/Nl2brViewHelper.php :navigation-title: format.nl2br .. include:: /Includes.rst.txt .. _typo3-fluid-format-nl2br: ========================================== -format.nl2br ViewHelper `` +Format.nl2br ViewHelper `` ========================================== - Wrapper for PHPs :php:`nl2br` function. See https://www.php.net/manual/function.nl2br.php. @@ -32,22 +35,32 @@ Inline notation Text with line breaks replaced by ``
    `` +.. _typo3-fluid-format-nl2br_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `Nl2brViewHelper.php (GitHub) `__. .. _typo3-fluid-format-nl2br_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-format-nl2br-value: +.. _typo3-fluid-format-nl2br-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-format-nl2br-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - String to format + String to format diff --git a/Documentation/typo3/fluid/latest/Format/Number.rst b/Documentation/typo3/fluid/latest/Format/Number.rst index 1a1645f..24a88bb 100644 --- a/Documentation/typo3/fluid/latest/Format/Number.rst +++ b/Documentation/typo3/fluid/latest/Format/Number.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/NumberViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/NumberViewHelper.php :navigation-title: format.number .. include:: /Includes.rst.txt .. _typo3-fluid-format-number: ============================================ -format.number ViewHelper `` +Format.number ViewHelper `` ============================================ - Formats a number with custom precision, decimal point and grouped thousands. See https://www.php.net/manual/function.number-format.php. @@ -34,57 +37,59 @@ With all parameters ``423.423,2`` +.. _typo3-fluid-format-number_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `NumberViewHelper.php (GitHub) `__. .. _typo3-fluid-format-number_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: -.. _typo3-fluid-format-number-decimals: + +.. _typo3-fluid-format-number-decimals_argument: decimals -------- -:aspect:`DataType` - mixed - -:aspect:`Default` - 2 +.. confval:: decimals + :name: typo3-fluid-format-number-decimals + :type: mixed + :Default: 2 + :required: false -:aspect:`Required` - false -:aspect:`Description` - The number of digits after the decimal point + The number of digits after the decimal point -.. _typo3-fluid-format-number-decimalseparator: +.. _typo3-fluid-format-number-decimalseparator_argument: decimalSeparator ---------------- -:aspect:`DataType` - string +.. confval:: decimalSeparator + :name: typo3-fluid-format-number-decimalseparator + :type: string + :Default: '.' + :required: false -:aspect:`Default` - '.' + The decimal point character -:aspect:`Required` - false -:aspect:`Description` - The decimal point character - -.. _typo3-fluid-format-number-thousandsseparator: +.. _typo3-fluid-format-number-thousandsseparator_argument: thousandsSeparator ------------------ -:aspect:`DataType` - string - -:aspect:`Default` - ',' +.. confval:: thousandsSeparator + :name: typo3-fluid-format-number-thousandsseparator + :type: string + :Default: ',' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The character for grouping the thousand digits + The character for grouping the thousand digits diff --git a/Documentation/typo3/fluid/latest/Format/Padding.rst b/Documentation/typo3/fluid/latest/Format/Padding.rst index 6678108..27adfca 100644 --- a/Documentation/typo3/fluid/latest/Format/Padding.rst +++ b/Documentation/typo3/fluid/latest/Format/Padding.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/PaddingViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/PaddingViewHelper.php :navigation-title: format.padding .. include:: /Includes.rst.txt .. _typo3-fluid-format-padding: ============================================== -format.padding ViewHelper `` +Format.padding ViewHelper `` ============================================== - Formats a string using PHPs :php:`str_pad` function. See https://www.php.net/manual/en/function.str-pad. @@ -45,67 +48,70 @@ Specify padding type ``--TYPO3---`` +.. _typo3-fluid-format-padding_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `PaddingViewHelper.php (GitHub) `__. .. _typo3-fluid-format-padding_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-format-padding-value: +.. contents:: + :local: + + +.. _typo3-fluid-format-padding-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-format-padding-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - String to format + String to format -.. _typo3-fluid-format-padding-padlength: +.. _typo3-fluid-format-padding-padlength_argument: padLength --------- -:aspect:`DataType` - mixed +.. confval:: padLength + :name: typo3-fluid-format-padding-padlength + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Length of the resulting string. If the value of pad_length is negative or less than the length of the input string, no padding takes place. + Length of the resulting string. If the value of pad_length is negative or less than the length of the input string, no padding takes place. -.. _typo3-fluid-format-padding-padstring: +.. _typo3-fluid-format-padding-padstring_argument: padString --------- -:aspect:`DataType` - string +.. confval:: padString + :name: typo3-fluid-format-padding-padstring + :type: string + :Default: ' ' + :required: false -:aspect:`Default` - ' ' + The padding string -:aspect:`Required` - false -:aspect:`Description` - The padding string - -.. _typo3-fluid-format-padding-padtype: +.. _typo3-fluid-format-padding-padtype_argument: padType ------- -:aspect:`DataType` - string - -:aspect:`Default` - 'right' +.. confval:: padType + :name: typo3-fluid-format-padding-padtype + :type: string + :Default: 'right' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Append the padding at this site (Possible values: right,left,both. Default: right) + Append the padding at this site (Possible values: right,left,both. Default: right) diff --git a/Documentation/typo3/fluid/latest/Format/StripTags.rst b/Documentation/typo3/fluid/latest/Format/StripTags.rst index 773cd2c..20824e7 100644 --- a/Documentation/typo3/fluid/latest/Format/StripTags.rst +++ b/Documentation/typo3/fluid/latest/Format/StripTags.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/StripTagsViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/StripTagsViewHelper.php :navigation-title: format.stripTags .. include:: /Includes.rst.txt .. _typo3-fluid-format-striptags: ================================================== -format.stripTags ViewHelper `` +Format.stripTags ViewHelper `` ================================================== - Removes tags from the given string (applying PHPs :php:`strip_tags()` function) See https://www.php.net/manual/function.strip-tags.php. @@ -57,35 +60,44 @@ Inline notation with allowedTags Text with p, span, div and script Tags inside, all other tags are removed. +.. _typo3-fluid-format-striptags_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `StripTagsViewHelper.php (GitHub) `__. .. _typo3-fluid-format-striptags_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-format-striptags-value: +.. _typo3-fluid-format-striptags-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-format-striptags-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - String to format + String to format -.. _typo3-fluid-format-striptags-allowedtags: +.. _typo3-fluid-format-striptags-allowedtags_argument: allowedTags ----------- -:aspect:`DataType` - string +.. confval:: allowedTags + :name: typo3-fluid-format-striptags-allowedtags + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Optional string of allowed tags as required by PHPs strip_tags() function + Optional string of allowed tags as required by PHPs strip_tags() function diff --git a/Documentation/typo3/fluid/latest/Format/Trim.rst b/Documentation/typo3/fluid/latest/Format/Trim.rst index 0678f34..8f94c97 100644 --- a/Documentation/typo3/fluid/latest/Format/Trim.rst +++ b/Documentation/typo3/fluid/latest/Format/Trim.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/TrimViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/TrimViewHelper.php :navigation-title: format.trim .. include:: /Includes.rst.txt .. _typo3-fluid-format-trim: ======================================== -format.trim ViewHelper `` +Format.trim ViewHelper `` ======================================== - This ViewHelper strips whitespace (or other characters) from the beginning and end of a string. Possible sides are: @@ -59,51 +62,57 @@ Trim special characters #ring to be trimmed# +.. _typo3-fluid-format-trim_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `TrimViewHelper.php (GitHub) `__. .. _typo3-fluid-format-trim_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-format-trim-value: +.. contents:: + :local: + + +.. _typo3-fluid-format-trim-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-format-trim-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The string value to be trimmed. If not given, the evaluated child nodes will be used. + The string value to be trimmed. If not given, the evaluated child nodes will be used. -.. _typo3-fluid-format-trim-characters: +.. _typo3-fluid-format-trim-characters_argument: characters ---------- -:aspect:`DataType` - string +.. confval:: characters + :name: typo3-fluid-format-trim-characters + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Optionally, the stripped characters can also be specified using the characters parameter. Simply list all characters that you want to be stripped. With .. you can specify a range of characters. + Optionally, the stripped characters can also be specified using the characters parameter. Simply list all characters that you want to be stripped. With .. you can specify a range of characters. -.. _typo3-fluid-format-trim-side: +.. _typo3-fluid-format-trim-side_argument: side ---- -:aspect:`DataType` - string - -:aspect:`Default` - 'both' +.. confval:: side + :name: typo3-fluid-format-trim-side + :type: string + :Default: 'both' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The side to apply, must be one of this' CASE_* constants. Defaults to both application. + The side to apply, must be one of this' CASE_* constants. Defaults to both application. diff --git a/Documentation/typo3/fluid/latest/Format/Urlencode.rst b/Documentation/typo3/fluid/latest/Format/Urlencode.rst index 5459934..739bc1e 100644 --- a/Documentation/typo3/fluid/latest/Format/Urlencode.rst +++ b/Documentation/typo3/fluid/latest/Format/Urlencode.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/UrlencodeViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Format/UrlencodeViewHelper.php :navigation-title: format.urlencode .. include:: /Includes.rst.txt .. _typo3-fluid-format-urlencode: ================================================== -format.urlencode ViewHelper `` +Format.urlencode ViewHelper `` ================================================== - Encodes the given string according to http://www.faqs.org/rfcs/rfc3986.html Applying PHPs :php:`rawurlencode()` function. See https://www.php.net/manual/function.rawurlencode.php. @@ -36,22 +39,32 @@ Inline notation Url encoded text :php:`rawurlencode()` applied. +.. _typo3-fluid-format-urlencode_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `UrlencodeViewHelper.php (GitHub) `__. .. _typo3-fluid-format-urlencode_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-format-urlencode-value: +.. _typo3-fluid-format-urlencode-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3-fluid-format-urlencode-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - String to format + String to format diff --git a/Documentation/typo3/fluid/latest/Image.rst b/Documentation/typo3/fluid/latest/Image.rst index 8bbe9fd..f784673 100644 --- a/Documentation/typo3/fluid/latest/Image.rst +++ b/Documentation/typo3/fluid/latest/Image.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/ImageViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/ImageViewHelper.php :navigation-title: image .. include:: /Includes.rst.txt .. _typo3-fluid-image: ============================ -image ViewHelper `` +Image ViewHelper `` ============================ - Resizes a given image (if required) and renders the respective img tag. Note that image operations (cropping, scaling, converting) on @@ -78,415 +81,393 @@ Non-existent image ``Could not get image resource for "NonExistingImage.png".`` +.. _typo3-fluid-image_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ImageViewHelper.php (GitHub) `__. .. _typo3-fluid-image_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-image-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-image-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-image-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-image-data: +.. _typo3-fluid-image-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-image-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-image-aria: +.. _typo3-fluid-image-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-image-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-image-class: +.. _typo3-fluid-image-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-image-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-image-dir: +.. _typo3-fluid-image-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-image-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-image-id: +.. _typo3-fluid-image-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-image-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-image-lang: +.. _typo3-fluid-image-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-image-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-image-style: +.. _typo3-fluid-image-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-image-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-image-title: +.. _typo3-fluid-image-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-image-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-image-accesskey: +.. _typo3-fluid-image-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-image-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-image-tabindex: +.. _typo3-fluid-image-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-image-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-image-onclick: +.. _typo3-fluid-image-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-image-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-image-alt: +.. _typo3-fluid-image-alt_argument: alt --- -:aspect:`DataType` - string +.. confval:: alt + :name: typo3-fluid-image-alt + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies an alternate text for an image + Specifies an alternate text for an image -.. _typo3-fluid-image-ismap: +.. _typo3-fluid-image-ismap_argument: ismap ----- -:aspect:`DataType` - string +.. confval:: ismap + :name: typo3-fluid-image-ismap + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies an image as a server-side image-map. Rarely used. Look at usemap instead + Specifies an image as a server-side image-map. Rarely used. Look at usemap instead -.. _typo3-fluid-image-longdesc: +.. _typo3-fluid-image-longdesc_argument: longdesc -------- -:aspect:`DataType` - string +.. confval:: longdesc + :name: typo3-fluid-image-longdesc + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the URL to a document that contains a long description of an image + Specifies the URL to a document that contains a long description of an image -.. _typo3-fluid-image-usemap: +.. _typo3-fluid-image-usemap_argument: usemap ------ -:aspect:`DataType` - string +.. confval:: usemap + :name: typo3-fluid-image-usemap + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies an image as a client-side image-map + Specifies an image as a client-side image-map -.. _typo3-fluid-image-loading: +.. _typo3-fluid-image-loading_argument: loading ------- -:aspect:`DataType` - string +.. confval:: loading + :name: typo3-fluid-image-loading + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Native lazy-loading for images property. Can be "lazy", "eager" or "auto" + Native lazy-loading for images property. Can be "lazy", "eager" or "auto" -.. _typo3-fluid-image-decoding: +.. _typo3-fluid-image-decoding_argument: decoding -------- -:aspect:`DataType` - string +.. confval:: decoding + :name: typo3-fluid-image-decoding + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Provides an image decoding hint to the browser. Can be "sync", "async" or "auto" + Provides an image decoding hint to the browser. Can be "sync", "async" or "auto" -.. _typo3-fluid-image-src: +.. _typo3-fluid-image-src_argument: src --- -:aspect:`DataType` - string +.. confval:: src + :name: typo3-fluid-image-src + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - A path to a file, a combined FAL identifier or an uid (int). If $treatIdAsReference is set, the integer is considered the uid of the sys_file_reference record. If you already got a FAL object, consider using the $image parameter instead + A path to a file, a combined FAL identifier or an uid (int). If $treatIdAsReference is set, the integer is considered the uid of the sys_file_reference record. If you already got a FAL object, consider using the $image parameter instead -.. _typo3-fluid-image-treatidasreference: +.. _typo3-fluid-image-treatidasreference_argument: treatIdAsReference ------------------ -:aspect:`DataType` - boolean +.. confval:: treatIdAsReference + :name: typo3-fluid-image-treatidasreference + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Given src argument is a sys_file_reference record + Given src argument is a sys_file_reference record -.. _typo3-fluid-image-image: +.. _typo3-fluid-image-image_argument: image ----- -:aspect:`DataType` - mixed +.. confval:: image + :name: typo3-fluid-image-image + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - A FAL object (\TYPO3\CMS\Core\Resource\File or \TYPO3\CMS\Core\Resource\FileReference) + A FAL object (\TYPO3\CMS\Core\Resource\File or \TYPO3\CMS\Core\Resource\FileReference) -.. _typo3-fluid-image-crop: +.. _typo3-fluid-image-crop_argument: crop ---- -:aspect:`DataType` - mixed +.. confval:: crop + :name: typo3-fluid-image-crop + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Overrule cropping of image (setting to FALSE disables the cropping set in FileReference) + Overrule cropping of image (setting to FALSE disables the cropping set in FileReference) -.. _typo3-fluid-image-cropvariant: +.. _typo3-fluid-image-cropvariant_argument: cropVariant ----------- -:aspect:`DataType` - string - -:aspect:`Default` - 'default' +.. confval:: cropVariant + :name: typo3-fluid-image-cropvariant + :type: string + :Default: 'default' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Select a cropping variant, in case multiple croppings have been specified or stored in FileReference + Select a cropping variant, in case multiple croppings have been specified or stored in FileReference -.. _typo3-fluid-image-fileextension: +.. _typo3-fluid-image-fileextension_argument: fileExtension ------------- -:aspect:`DataType` - string +.. confval:: fileExtension + :name: typo3-fluid-image-fileextension + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Custom file extension to use + Custom file extension to use -.. _typo3-fluid-image-width: +.. _typo3-fluid-image-width_argument: width ----- -:aspect:`DataType` - string +.. confval:: width + :name: typo3-fluid-image-width + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. + Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. -.. _typo3-fluid-image-height: +.. _typo3-fluid-image-height_argument: height ------ -:aspect:`DataType` - string +.. confval:: height + :name: typo3-fluid-image-height + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. + Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. -.. _typo3-fluid-image-minwidth: +.. _typo3-fluid-image-minwidth_argument: minWidth -------- -:aspect:`DataType` - mixed +.. confval:: minWidth + :name: typo3-fluid-image-minwidth + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Minimum width of the image + Minimum width of the image -.. _typo3-fluid-image-minheight: +.. _typo3-fluid-image-minheight_argument: minHeight --------- -:aspect:`DataType` - mixed +.. confval:: minHeight + :name: typo3-fluid-image-minheight + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Minimum height of the image + Minimum height of the image -.. _typo3-fluid-image-maxwidth: +.. _typo3-fluid-image-maxwidth_argument: maxWidth -------- -:aspect:`DataType` - mixed +.. confval:: maxWidth + :name: typo3-fluid-image-maxwidth + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Maximum width of the image + Maximum width of the image -.. _typo3-fluid-image-maxheight: +.. _typo3-fluid-image-maxheight_argument: maxHeight --------- -:aspect:`DataType` - mixed +.. confval:: maxHeight + :name: typo3-fluid-image-maxheight + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Maximum height of the image + Maximum height of the image -.. _typo3-fluid-image-absolute: +.. _typo3-fluid-image-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-image-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Force absolute URL + Force absolute URL diff --git a/Documentation/typo3/fluid/latest/Link/Action.rst b/Documentation/typo3/fluid/latest/Link/Action.rst index 363e864..e0b6069 100644 --- a/Documentation/typo3/fluid/latest/Link/Action.rst +++ b/Documentation/typo3/fluid/latest/Link/Action.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/ActionViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/ActionViewHelper.php :navigation-title: link.action .. include:: /Includes.rst.txt .. _typo3-fluid-link-action: ======================================== -link.action ViewHelper `` +Link.action ViewHelper `` ======================================== - A ViewHelper for creating links to extbase actions. Tailored for extbase plugins, uses extbase Request and extbase UriBuilder. Examples @@ -23,425 +26,404 @@ Output:: Depending on the current page and your TypoScript configuration. +.. _typo3-fluid-link-action_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ActionViewHelper.php (GitHub) `__. .. _typo3-fluid-link-action_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-link-action-additionalattributes: +.. _typo3-fluid-link-action-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-link-action-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-link-action-data: +.. _typo3-fluid-link-action-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-link-action-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-link-action-aria: +.. _typo3-fluid-link-action-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-link-action-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-link-action-class: +.. _typo3-fluid-link-action-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-link-action-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-link-action-dir: +.. _typo3-fluid-link-action-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-link-action-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-link-action-id: +.. _typo3-fluid-link-action-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-link-action-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-link-action-lang: +.. _typo3-fluid-link-action-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-link-action-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-link-action-style: +.. _typo3-fluid-link-action-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-link-action-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-link-action-title: +.. _typo3-fluid-link-action-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-link-action-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-link-action-accesskey: +.. _typo3-fluid-link-action-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-link-action-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-link-action-tabindex: +.. _typo3-fluid-link-action-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-link-action-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-link-action-onclick: +.. _typo3-fluid-link-action-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-link-action-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-link-action-name: +.. _typo3-fluid-link-action-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-link-action-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the name of an anchor + Specifies the name of an anchor -.. _typo3-fluid-link-action-rel: +.. _typo3-fluid-link-action-rel_argument: rel --- -:aspect:`DataType` - string +.. confval:: rel + :name: typo3-fluid-link-action-rel + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the current document and the linked document + Specifies the relationship between the current document and the linked document -.. _typo3-fluid-link-action-rev: +.. _typo3-fluid-link-action-rev_argument: rev --- -:aspect:`DataType` - string +.. confval:: rev + :name: typo3-fluid-link-action-rev + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the linked document and the current document + Specifies the relationship between the linked document and the current document -.. _typo3-fluid-link-action-target: +.. _typo3-fluid-link-action-target_argument: target ------ -:aspect:`DataType` - string +.. confval:: target + :name: typo3-fluid-link-action-target + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies where to open the linked document + Specifies where to open the linked document -.. _typo3-fluid-link-action-action: +.. _typo3-fluid-link-action-action_argument: action ------ -:aspect:`DataType` - string +.. confval:: action + :name: typo3-fluid-link-action-action + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target action + Target action -.. _typo3-fluid-link-action-controller: +.. _typo3-fluid-link-action-controller_argument: controller ---------- -:aspect:`DataType` - string +.. confval:: controller + :name: typo3-fluid-link-action-controller + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target controller. If NULL current controllerName is used + Target controller. If NULL current controllerName is used -.. _typo3-fluid-link-action-extensionname: +.. _typo3-fluid-link-action-extensionname_argument: extensionName ------------- -:aspect:`DataType` - string +.. confval:: extensionName + :name: typo3-fluid-link-action-extensionname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target Extension Name (without `tx_` prefix and no underscores). If NULL the current extension name is used + Target Extension Name (without `tx_` prefix and no underscores). If NULL the current extension name is used -.. _typo3-fluid-link-action-pluginname: +.. _typo3-fluid-link-action-pluginname_argument: pluginName ---------- -:aspect:`DataType` - string +.. confval:: pluginName + :name: typo3-fluid-link-action-pluginname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target plugin. If empty, the current plugin name is used + Target plugin. If empty, the current plugin name is used -.. _typo3-fluid-link-action-pageuid: +.. _typo3-fluid-link-action-pageuid_argument: pageUid ------- -:aspect:`DataType` - mixed +.. confval:: pageUid + :name: typo3-fluid-link-action-pageuid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target page. See TypoLink destination + Target page. See TypoLink destination -.. _typo3-fluid-link-action-pagetype: +.. _typo3-fluid-link-action-pagetype_argument: pageType -------- -:aspect:`DataType` - mixed +.. confval:: pageType + :name: typo3-fluid-link-action-pagetype + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Type of the target page. See typolink.parameter + Type of the target page. See typolink.parameter -.. _typo3-fluid-link-action-nocache: +.. _typo3-fluid-link-action-nocache_argument: noCache ------- -:aspect:`DataType` - boolean +.. confval:: noCache + :name: typo3-fluid-link-action-nocache + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Set this to disable caching for the target page. You should not need this. + Set this to disable caching for the target page. You should not need this. -.. _typo3-fluid-link-action-language: +.. _typo3-fluid-link-action-language_argument: language -------- -:aspect:`DataType` - string +.. confval:: language + :name: typo3-fluid-link-action-language + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language + Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language -.. _typo3-fluid-link-action-section: +.. _typo3-fluid-link-action-section_argument: section ------- -:aspect:`DataType` - string +.. confval:: section + :name: typo3-fluid-link-action-section + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The anchor to be added to the URI + The anchor to be added to the URI -.. _typo3-fluid-link-action-format: +.. _typo3-fluid-link-action-format_argument: format ------ -:aspect:`DataType` - string +.. confval:: format + :name: typo3-fluid-link-action-format + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The requested format, e.g. ".html + The requested format, e.g. ".html -.. _typo3-fluid-link-action-linkaccessrestrictedpages: +.. _typo3-fluid-link-action-linkaccessrestrictedpages_argument: linkAccessRestrictedPages ------------------------- -:aspect:`DataType` - boolean +.. confval:: linkAccessRestrictedPages + :name: typo3-fluid-link-action-linkaccessrestrictedpages + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed. + If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed. -.. _typo3-fluid-link-action-additionalparams: +.. _typo3-fluid-link-action-additionalparams_argument: additionalParams ---------------- -:aspect:`DataType` - mixed +.. confval:: additionalParams + :name: typo3-fluid-link-action-additionalparams + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional query parameters that won't be prefixed like $arguments (overrule $arguments) + Additional query parameters that won't be prefixed like $arguments (overrule $arguments) -.. _typo3-fluid-link-action-absolute: +.. _typo3-fluid-link-action-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-link-action-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the URI of the rendered link is absolute + If set, the URI of the rendered link is absolute -.. _typo3-fluid-link-action-addquerystring: +.. _typo3-fluid-link-action-addquerystring_argument: addQueryString -------------- -:aspect:`DataType` - string +.. confval:: addQueryString + :name: typo3-fluid-link-action-addquerystring + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. + If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. -.. _typo3-fluid-link-action-argumentstobeexcludedfromquerystring: +.. _typo3-fluid-link-action-argumentstobeexcludedfromquerystring_argument: argumentsToBeExcludedFromQueryString ------------------------------------ -:aspect:`DataType` - mixed +.. confval:: argumentsToBeExcludedFromQueryString + :name: typo3-fluid-link-action-argumentstobeexcludedfromquerystring + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments to be removed from the URI. Only active if $addQueryString = TRUE + Arguments to be removed from the URI. Only active if $addQueryString = TRUE -.. _typo3-fluid-link-action-arguments: +.. _typo3-fluid-link-action-arguments_argument: arguments --------- -:aspect:`DataType` - mixed +.. confval:: arguments + :name: typo3-fluid-link-action-arguments + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments for the controller action, associative array + Arguments for the controller action, associative array diff --git a/Documentation/typo3/fluid/latest/Link/Email.rst b/Documentation/typo3/fluid/latest/Link/Email.rst index dbf5e49..3568899 100644 --- a/Documentation/typo3/fluid/latest/Link/Email.rst +++ b/Documentation/typo3/fluid/latest/Link/Email.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/EmailViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/EmailViewHelper.php :navigation-title: link.email .. include:: /Includes.rst.txt .. _typo3-fluid-link-email: ====================================== -link.email ViewHelper `` +Link.email ViewHelper `` ====================================== - Email link ViewHelper. Generates an email link incorporating TYPO3s `spamProtectEmailAddresses`_ TypoScript setting. @@ -52,282 +55,272 @@ Output:: Depending on `spamProtectEmailAddresses`_ setting. +.. _typo3-fluid-link-email_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `EmailViewHelper.php (GitHub) `__. .. _typo3-fluid-link-email_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-link-email-additionalattributes: +.. _typo3-fluid-link-email-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-link-email-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-link-email-data: +.. _typo3-fluid-link-email-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-link-email-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-link-email-aria: +.. _typo3-fluid-link-email-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-link-email-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-link-email-email: +.. _typo3-fluid-link-email-email_argument: email ----- -:aspect:`DataType` - string +.. confval:: email + :name: typo3-fluid-link-email-email + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The email address to be turned into a link + The email address to be turned into a link -.. _typo3-fluid-link-email-cc: +.. _typo3-fluid-link-email-cc_argument: cc -- -:aspect:`DataType` - string +.. confval:: cc + :name: typo3-fluid-link-email-cc + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The email address(es) for CC of the email link + The email address(es) for CC of the email link -.. _typo3-fluid-link-email-bcc: +.. _typo3-fluid-link-email-bcc_argument: bcc --- -:aspect:`DataType` - string +.. confval:: bcc + :name: typo3-fluid-link-email-bcc + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The email address(es) for BCC of the email link + The email address(es) for BCC of the email link -.. _typo3-fluid-link-email-subject: +.. _typo3-fluid-link-email-subject_argument: subject ------- -:aspect:`DataType` - string +.. confval:: subject + :name: typo3-fluid-link-email-subject + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - A prefilled subject for the email link + A prefilled subject for the email link -.. _typo3-fluid-link-email-body: +.. _typo3-fluid-link-email-body_argument: body ---- -:aspect:`DataType` - string +.. confval:: body + :name: typo3-fluid-link-email-body + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - A prefilled body for the email link + A prefilled body for the email link -.. _typo3-fluid-link-email-class: +.. _typo3-fluid-link-email-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-link-email-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-link-email-dir: +.. _typo3-fluid-link-email-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-link-email-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-link-email-id: +.. _typo3-fluid-link-email-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-link-email-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-link-email-lang: +.. _typo3-fluid-link-email-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-link-email-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-link-email-style: +.. _typo3-fluid-link-email-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-link-email-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-link-email-title: +.. _typo3-fluid-link-email-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-link-email-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-link-email-accesskey: +.. _typo3-fluid-link-email-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-link-email-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-link-email-tabindex: +.. _typo3-fluid-link-email-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-link-email-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-link-email-onclick: +.. _typo3-fluid-link-email-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-link-email-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-link-email-name: +.. _typo3-fluid-link-email-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-link-email-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the name of an anchor + Specifies the name of an anchor -.. _typo3-fluid-link-email-rel: +.. _typo3-fluid-link-email-rel_argument: rel --- -:aspect:`DataType` - string +.. confval:: rel + :name: typo3-fluid-link-email-rel + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the current document and the linked document + Specifies the relationship between the current document and the linked document -.. _typo3-fluid-link-email-rev: +.. _typo3-fluid-link-email-rev_argument: rev --- -:aspect:`DataType` - string +.. confval:: rev + :name: typo3-fluid-link-email-rev + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the linked document and the current document + Specifies the relationship between the linked document and the current document -.. _typo3-fluid-link-email-target: +.. _typo3-fluid-link-email-target_argument: target ------ -:aspect:`DataType` - string +.. confval:: target + :name: typo3-fluid-link-email-target + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies where to open the linked document + Specifies where to open the linked document diff --git a/Documentation/typo3/fluid/latest/Link/External.rst b/Documentation/typo3/fluid/latest/Link/External.rst index 423b64b..7ca5052 100644 --- a/Documentation/typo3/fluid/latest/Link/External.rst +++ b/Documentation/typo3/fluid/latest/Link/External.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/ExternalViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/ExternalViewHelper.php :navigation-title: link.external .. include:: /Includes.rst.txt .. _typo3-fluid-link-external: ============================================ -link.external ViewHelper `` +Link.external ViewHelper `` ============================================ - A ViewHelper for creating links to external targets. Examples @@ -35,246 +38,237 @@ Output:: external ftp link +.. _typo3-fluid-link-external_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ExternalViewHelper.php (GitHub) `__. .. _typo3-fluid-link-external_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-link-external-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-link-external-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-link-external-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-link-external-data: +.. _typo3-fluid-link-external-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-link-external-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-link-external-aria: +.. _typo3-fluid-link-external-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-link-external-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-link-external-uri: +.. _typo3-fluid-link-external-uri_argument: uri --- -:aspect:`DataType` - string +.. confval:: uri + :name: typo3-fluid-link-external-uri + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The URI that will be put in the href attribute of the rendered link tag + The URI that will be put in the href attribute of the rendered link tag -.. _typo3-fluid-link-external-defaultscheme: +.. _typo3-fluid-link-external-defaultscheme_argument: defaultScheme ------------- -:aspect:`DataType` - string - -:aspect:`Default` - 'https' +.. confval:: defaultScheme + :name: typo3-fluid-link-external-defaultscheme + :type: string + :Default: 'https' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Scheme the href attribute will be prefixed with if specified $uri does not contain a scheme already + Scheme the href attribute will be prefixed with if specified $uri does not contain a scheme already -.. _typo3-fluid-link-external-class: +.. _typo3-fluid-link-external-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-link-external-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-link-external-dir: +.. _typo3-fluid-link-external-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-link-external-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-link-external-id: +.. _typo3-fluid-link-external-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-link-external-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-link-external-lang: +.. _typo3-fluid-link-external-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-link-external-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-link-external-style: +.. _typo3-fluid-link-external-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-link-external-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-link-external-title: +.. _typo3-fluid-link-external-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-link-external-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-link-external-accesskey: +.. _typo3-fluid-link-external-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-link-external-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-link-external-tabindex: +.. _typo3-fluid-link-external-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-link-external-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-link-external-onclick: +.. _typo3-fluid-link-external-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-link-external-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-link-external-name: +.. _typo3-fluid-link-external-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-link-external-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the name of an anchor + Specifies the name of an anchor -.. _typo3-fluid-link-external-rel: +.. _typo3-fluid-link-external-rel_argument: rel --- -:aspect:`DataType` - string +.. confval:: rel + :name: typo3-fluid-link-external-rel + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the current document and the linked document + Specifies the relationship between the current document and the linked document -.. _typo3-fluid-link-external-rev: +.. _typo3-fluid-link-external-rev_argument: rev --- -:aspect:`DataType` - string +.. confval:: rev + :name: typo3-fluid-link-external-rev + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the linked document and the current document + Specifies the relationship between the linked document and the current document -.. _typo3-fluid-link-external-target: +.. _typo3-fluid-link-external-target_argument: target ------ -:aspect:`DataType` - string +.. confval:: target + :name: typo3-fluid-link-external-target + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies where to open the linked document + Specifies where to open the linked document diff --git a/Documentation/typo3/fluid/latest/Link/File.rst b/Documentation/typo3/fluid/latest/Link/File.rst index ef1eb4b..b0a7ec1 100644 --- a/Documentation/typo3/fluid/latest/Link/File.rst +++ b/Documentation/typo3/fluid/latest/Link/File.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/FileViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/FileViewHelper.php :navigation-title: link.file .. include:: /Includes.rst.txt .. _typo3-fluid-link-file: ==================================== -link.file ViewHelper `` +Link.file ViewHelper `` ==================================== - A ViewHelper for creating links to a file (FAL). Examples @@ -43,256 +46,248 @@ Output of a non-public file:: Download file +.. _typo3-fluid-link-file_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `FileViewHelper.php (GitHub) `__. .. _typo3-fluid-link-file_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-link-file-additionalattributes: +.. _typo3-fluid-link-file-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-link-file-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-link-file-data: +.. _typo3-fluid-link-file-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-link-file-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-link-file-aria: +.. _typo3-fluid-link-file-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-link-file-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-link-file-file: +.. _typo3-fluid-link-file-file_argument: file ---- -:aspect:`DataType` - mixed +.. confval:: file + :name: typo3-fluid-link-file-file + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Specifies the file to create a link to + Specifies the file to create a link to -.. _typo3-fluid-link-file-download: +.. _typo3-fluid-link-file-download_argument: download -------- -:aspect:`DataType` - boolean +.. confval:: download + :name: typo3-fluid-link-file-download + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies if file should be downloaded instead of displayed + Specifies if file should be downloaded instead of displayed -.. _typo3-fluid-link-file-filename: +.. _typo3-fluid-link-file-filename_argument: filename -------- -:aspect:`DataType` - string +.. confval:: filename + :name: typo3-fluid-link-file-filename + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies an alternative filename. If filename contains a file extension, this must be the same as from 'file'. + Specifies an alternative filename. If filename contains a file extension, this must be the same as from 'file'. -.. _typo3-fluid-link-file-class: +.. _typo3-fluid-link-file-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-link-file-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-link-file-dir: +.. _typo3-fluid-link-file-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-link-file-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-link-file-id: +.. _typo3-fluid-link-file-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-link-file-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-link-file-lang: +.. _typo3-fluid-link-file-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-link-file-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-link-file-style: +.. _typo3-fluid-link-file-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-link-file-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-link-file-title: +.. _typo3-fluid-link-file-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-link-file-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-link-file-accesskey: +.. _typo3-fluid-link-file-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-link-file-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-link-file-tabindex: +.. _typo3-fluid-link-file-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-link-file-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-link-file-onclick: +.. _typo3-fluid-link-file-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-link-file-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-link-file-name: +.. _typo3-fluid-link-file-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3-fluid-link-file-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the name of an anchor + Specifies the name of an anchor -.. _typo3-fluid-link-file-rel: +.. _typo3-fluid-link-file-rel_argument: rel --- -:aspect:`DataType` - string +.. confval:: rel + :name: typo3-fluid-link-file-rel + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the current document and the linked document + Specifies the relationship between the current document and the linked document -.. _typo3-fluid-link-file-rev: +.. _typo3-fluid-link-file-rev_argument: rev --- -:aspect:`DataType` - string +.. confval:: rev + :name: typo3-fluid-link-file-rev + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the linked document and the current document + Specifies the relationship between the linked document and the current document -.. _typo3-fluid-link-file-target: +.. _typo3-fluid-link-file-target_argument: target ------ -:aspect:`DataType` - string +.. confval:: target + :name: typo3-fluid-link-file-target + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies where to open the linked document + Specifies where to open the linked document diff --git a/Documentation/typo3/fluid/latest/Link/Page.rst b/Documentation/typo3/fluid/latest/Link/Page.rst index f7079fc..d40404d 100644 --- a/Documentation/typo3/fluid/latest/Link/Page.rst +++ b/Documentation/typo3/fluid/latest/Link/Page.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/PageViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/PageViewHelper.php :navigation-title: link.page .. include:: /Includes.rst.txt .. _typo3-fluid-link-page: ==================================== -link.page ViewHelper `` +Link.page ViewHelper `` ==================================== - A ViewHelper for creating links to TYPO3 pages. Examples @@ -52,321 +55,308 @@ Output:: Depending on current page, routing and page path configuration. +.. _typo3-fluid-link-page_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `PageViewHelper.php (GitHub) `__. .. _typo3-fluid-link-page_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-link-page-additionalattributes: +.. _typo3-fluid-link-page-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-link-page-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-link-page-data: +.. _typo3-fluid-link-page-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-link-page-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-link-page-aria: +.. _typo3-fluid-link-page-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-link-page-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-link-page-class: +.. _typo3-fluid-link-page-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-link-page-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-link-page-dir: +.. _typo3-fluid-link-page-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-link-page-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-link-page-id: +.. _typo3-fluid-link-page-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-link-page-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-link-page-lang: +.. _typo3-fluid-link-page-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-link-page-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-link-page-style: +.. _typo3-fluid-link-page-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-link-page-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-link-page-title: +.. _typo3-fluid-link-page-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-link-page-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-link-page-accesskey: +.. _typo3-fluid-link-page-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-link-page-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-link-page-tabindex: +.. _typo3-fluid-link-page-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-link-page-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-link-page-onclick: +.. _typo3-fluid-link-page-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-link-page-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-link-page-target: +.. _typo3-fluid-link-page-target_argument: target ------ -:aspect:`DataType` - string +.. confval:: target + :name: typo3-fluid-link-page-target + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target of link + Target of link -.. _typo3-fluid-link-page-rel: +.. _typo3-fluid-link-page-rel_argument: rel --- -:aspect:`DataType` - string +.. confval:: rel + :name: typo3-fluid-link-page-rel + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the relationship between the current document and the linked document + Specifies the relationship between the current document and the linked document -.. _typo3-fluid-link-page-pageuid: +.. _typo3-fluid-link-page-pageuid_argument: pageUid ------- -:aspect:`DataType` - mixed +.. confval:: pageUid + :name: typo3-fluid-link-page-pageuid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target page. See TypoLink destination + Target page. See TypoLink destination -.. _typo3-fluid-link-page-pagetype: +.. _typo3-fluid-link-page-pagetype_argument: pageType -------- -:aspect:`DataType` - mixed +.. confval:: pageType + :name: typo3-fluid-link-page-pagetype + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Type of the target page. See typolink.parameter + Type of the target page. See typolink.parameter -.. _typo3-fluid-link-page-nocache: +.. _typo3-fluid-link-page-nocache_argument: noCache ------- -:aspect:`DataType` - boolean +.. confval:: noCache + :name: typo3-fluid-link-page-nocache + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Set this to disable caching for the target page. You should not need this. + Set this to disable caching for the target page. You should not need this. -.. _typo3-fluid-link-page-language: +.. _typo3-fluid-link-page-language_argument: language -------- -:aspect:`DataType` - string +.. confval:: language + :name: typo3-fluid-link-page-language + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language + Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language -.. _typo3-fluid-link-page-section: +.. _typo3-fluid-link-page-section_argument: section ------- -:aspect:`DataType` - string +.. confval:: section + :name: typo3-fluid-link-page-section + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The anchor to be added to the URI + The anchor to be added to the URI -.. _typo3-fluid-link-page-linkaccessrestrictedpages: +.. _typo3-fluid-link-page-linkaccessrestrictedpages_argument: linkAccessRestrictedPages ------------------------- -:aspect:`DataType` - boolean +.. confval:: linkAccessRestrictedPages + :name: typo3-fluid-link-page-linkaccessrestrictedpages + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed. + If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed. -.. _typo3-fluid-link-page-additionalparams: +.. _typo3-fluid-link-page-additionalparams_argument: additionalParams ---------------- -:aspect:`DataType` - mixed +.. confval:: additionalParams + :name: typo3-fluid-link-page-additionalparams + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional query parameters that won't be prefixed like $arguments (overrule $arguments) + Additional query parameters that won't be prefixed like $arguments (overrule $arguments) -.. _typo3-fluid-link-page-absolute: +.. _typo3-fluid-link-page-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-link-page-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the URI of the rendered link is absolute + If set, the URI of the rendered link is absolute -.. _typo3-fluid-link-page-addquerystring: +.. _typo3-fluid-link-page-addquerystring_argument: addQueryString -------------- -:aspect:`DataType` - string +.. confval:: addQueryString + :name: typo3-fluid-link-page-addquerystring + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. + If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. -.. _typo3-fluid-link-page-argumentstobeexcludedfromquerystring: +.. _typo3-fluid-link-page-argumentstobeexcludedfromquerystring_argument: argumentsToBeExcludedFromQueryString ------------------------------------ -:aspect:`DataType` - mixed +.. confval:: argumentsToBeExcludedFromQueryString + :name: typo3-fluid-link-page-argumentstobeexcludedfromquerystring + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments to be removed from the URI. Only active if $addQueryString = TRUE + Arguments to be removed from the URI. Only active if $addQueryString = TRUE diff --git a/Documentation/typo3/fluid/latest/Link/Typolink.rst b/Documentation/typo3/fluid/latest/Link/Typolink.rst index 94228ff..503ec32 100644 --- a/Documentation/typo3/fluid/latest/Link/Typolink.rst +++ b/Documentation/typo3/fluid/latest/Link/Typolink.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/TypolinkViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Link/TypolinkViewHelper.php :navigation-title: link.typolink .. include:: /Includes.rst.txt .. _typo3-fluid-link-typolink: ============================================ -link.typolink ViewHelper `` +Link.typolink ViewHelper `` ============================================ - A ViewHelper to create links from fields supported by the link wizard Example @@ -71,171 +74,166 @@ Output:: Depending on routing and page path configuration. +.. _typo3-fluid-link-typolink_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `TypolinkViewHelper.php (GitHub) `__. .. _typo3-fluid-link-typolink_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-link-typolink-parameter: +.. contents:: + :local: + + +.. _typo3-fluid-link-typolink-parameter_argument: parameter --------- -:aspect:`DataType` - string +.. confval:: parameter + :name: typo3-fluid-link-typolink-parameter + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - StdWrap.typolink style parameter string + StdWrap.typolink style parameter string -.. _typo3-fluid-link-typolink-target: +.. _typo3-fluid-link-typolink-target_argument: target ------ -:aspect:`DataType` - string +.. confval:: target + :name: typo3-fluid-link-typolink-target + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define where to display the linked URL + Define where to display the linked URL -.. _typo3-fluid-link-typolink-class: +.. _typo3-fluid-link-typolink-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-link-typolink-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define classes for the link element + Define classes for the link element -.. _typo3-fluid-link-typolink-title: +.. _typo3-fluid-link-typolink-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-link-typolink-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define the title for the link element + Define the title for the link element -.. _typo3-fluid-link-typolink-language: +.. _typo3-fluid-link-typolink-language_argument: language -------- -:aspect:`DataType` - string +.. confval:: language + :name: typo3-fluid-link-typolink-language + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language + Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language -.. _typo3-fluid-link-typolink-additionalparams: +.. _typo3-fluid-link-typolink-additionalparams_argument: additionalParams ---------------- -:aspect:`DataType` - string +.. confval:: additionalParams + :name: typo3-fluid-link-typolink-additionalparams + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional query parameters to be attached to the resulting URL + Additional query parameters to be attached to the resulting URL -.. _typo3-fluid-link-typolink-additionalattributes: +.. _typo3-fluid-link-typolink-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-link-typolink-additionalattributes + :type: mixed + :Default: array () + :required: false -:aspect:`Default` - array () + Additional tag attributes to be added directly to the resulting HTML tag -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes to be added directly to the resulting HTML tag - -.. _typo3-fluid-link-typolink-addquerystring: +.. _typo3-fluid-link-typolink-addquerystring_argument: addQueryString -------------- -:aspect:`DataType` - string +.. confval:: addQueryString + :name: typo3-fluid-link-typolink-addquerystring + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. + If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. -.. _typo3-fluid-link-typolink-addquerystringexclude: +.. _typo3-fluid-link-typolink-addquerystringexclude_argument: addQueryStringExclude --------------------- -:aspect:`DataType` - string +.. confval:: addQueryStringExclude + :name: typo3-fluid-link-typolink-addquerystringexclude + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define parameters to be excluded from the query string (only active if addQueryString is set) + Define parameters to be excluded from the query string (only active if addQueryString is set) -.. _typo3-fluid-link-typolink-absolute: +.. _typo3-fluid-link-typolink-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-link-typolink-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Ensure the resulting URL is an absolute URL + Ensure the resulting URL is an absolute URL -.. _typo3-fluid-link-typolink-parts-as: +.. _typo3-fluid-link-typolink-parts-as_argument: parts-as -------- -:aspect:`DataType` - string - -:aspect:`Default` - 'typoLinkParts' +.. confval:: parts-as + :name: typo3-fluid-link-typolink-parts-as + :type: string + :Default: 'typoLinkParts' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Variable name containing typoLink parts (if any) + Variable name containing typoLink parts (if any) -.. _typo3-fluid-link-typolink-textwrap: +.. _typo3-fluid-link-typolink-textwrap_argument: textWrap -------- -:aspect:`DataType` - string +.. confval:: textWrap + :name: typo3-fluid-link-typolink-textwrap + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Wrap the link using the typoscript "wrap" data type + Wrap the link using the typoscript "wrap" data type diff --git a/Documentation/typo3/fluid/latest/Media.rst b/Documentation/typo3/fluid/latest/Media.rst index 4cbb88f..32bdbb0 100644 --- a/Documentation/typo3/fluid/latest/Media.rst +++ b/Documentation/typo3/fluid/latest/Media.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/MediaViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/MediaViewHelper.php :navigation-title: media .. include:: /Includes.rst.txt .. _typo3-fluid-media: ============================ -media ViewHelper `` +Media ViewHelper `` ============================ - Render a given media file with the correct html tag. It asks the :php:`RendererRegistry` for the correct Renderer class and if not found it falls @@ -49,288 +52,274 @@ Output:: +.. _typo3-fluid-media_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `MediaViewHelper.php (GitHub) `__. .. _typo3-fluid-media_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-media-additionalattributes: +.. contents:: + :local: + + +.. _typo3-fluid-media-additionalattributes_argument: additionalAttributes -------------------- -:aspect:`DataType` - mixed +.. confval:: additionalAttributes + :name: typo3-fluid-media-additionalattributes + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional tag attributes. They will be added directly to the resulting HTML tag. + Additional tag attributes. They will be added directly to the resulting HTML tag. -.. _typo3-fluid-media-data: +.. _typo3-fluid-media-data_argument: data ---- -:aspect:`DataType` - mixed +.. confval:: data + :name: typo3-fluid-media-data + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional data-* attributes. They will each be added with a "data-" prefix. + Additional data-* attributes. They will each be added with a "data-" prefix. -.. _typo3-fluid-media-aria: +.. _typo3-fluid-media-aria_argument: aria ---- -:aspect:`DataType` - mixed +.. confval:: aria + :name: typo3-fluid-media-aria + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Additional aria-* attributes. They will each be added with a "aria-" prefix. + Additional aria-* attributes. They will each be added with a "aria-" prefix. -.. _typo3-fluid-media-class: +.. _typo3-fluid-media-class_argument: class ----- -:aspect:`DataType` - string +.. confval:: class + :name: typo3-fluid-media-class + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - CSS class(es) for this element + CSS class(es) for this element -.. _typo3-fluid-media-dir: +.. _typo3-fluid-media-dir_argument: dir --- -:aspect:`DataType` - string +.. confval:: dir + :name: typo3-fluid-media-dir + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) + Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left) -.. _typo3-fluid-media-id: +.. _typo3-fluid-media-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-media-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Unique (in this file) identifier for this HTML element. + Unique (in this file) identifier for this HTML element. -.. _typo3-fluid-media-lang: +.. _typo3-fluid-media-lang_argument: lang ---- -:aspect:`DataType` - string +.. confval:: lang + :name: typo3-fluid-media-lang + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language for this element. Use short names specified in RFC 1766 + Language for this element. Use short names specified in RFC 1766 -.. _typo3-fluid-media-style: +.. _typo3-fluid-media-style_argument: style ----- -:aspect:`DataType` - string +.. confval:: style + :name: typo3-fluid-media-style + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Individual CSS styles for this element + Individual CSS styles for this element -.. _typo3-fluid-media-title: +.. _typo3-fluid-media-title_argument: title ----- -:aspect:`DataType` - string +.. confval:: title + :name: typo3-fluid-media-title + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Tooltip text of element + Tooltip text of element -.. _typo3-fluid-media-accesskey: +.. _typo3-fluid-media-accesskey_argument: accesskey --------- -:aspect:`DataType` - string +.. confval:: accesskey + :name: typo3-fluid-media-accesskey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Keyboard shortcut to access this element + Keyboard shortcut to access this element -.. _typo3-fluid-media-tabindex: +.. _typo3-fluid-media-tabindex_argument: tabindex -------- -:aspect:`DataType` - integer +.. confval:: tabindex + :name: typo3-fluid-media-tabindex + :type: integer + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies the tab order of this element + Specifies the tab order of this element -.. _typo3-fluid-media-onclick: +.. _typo3-fluid-media-onclick_argument: onclick ------- -:aspect:`DataType` - string +.. confval:: onclick + :name: typo3-fluid-media-onclick + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - JavaScript evaluated for the onclick event + JavaScript evaluated for the onclick event -.. _typo3-fluid-media-alt: +.. _typo3-fluid-media-alt_argument: alt --- -:aspect:`DataType` - string +.. confval:: alt + :name: typo3-fluid-media-alt + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Specifies an alternate text for an image + Specifies an alternate text for an image -.. _typo3-fluid-media-file: +.. _typo3-fluid-media-file_argument: file ---- -:aspect:`DataType` - mixed +.. confval:: file + :name: typo3-fluid-media-file + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - File + File -.. _typo3-fluid-media-additionalconfig: +.. _typo3-fluid-media-additionalconfig_argument: additionalConfig ---------------- -:aspect:`DataType` - mixed +.. confval:: additionalConfig + :name: typo3-fluid-media-additionalconfig + :type: mixed + :Default: array () + :required: false -:aspect:`Default` - array () + This array can hold additional configuration that is passed though to the Renderer object -:aspect:`Required` - false -:aspect:`Description` - This array can hold additional configuration that is passed though to the Renderer object - -.. _typo3-fluid-media-width: +.. _typo3-fluid-media-width_argument: width ----- -:aspect:`DataType` - string +.. confval:: width + :name: typo3-fluid-media-width + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - This can be a numeric value representing the fixed width of in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. + This can be a numeric value representing the fixed width of in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. -.. _typo3-fluid-media-height: +.. _typo3-fluid-media-height_argument: height ------ -:aspect:`DataType` - string +.. confval:: height + :name: typo3-fluid-media-height + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - This can be a numeric value representing the fixed height in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. + This can be a numeric value representing the fixed height in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. -.. _typo3-fluid-media-cropvariant: +.. _typo3-fluid-media-cropvariant_argument: cropVariant ----------- -:aspect:`DataType` - string - -:aspect:`Default` - 'default' +.. confval:: cropVariant + :name: typo3-fluid-media-cropvariant + :type: string + :Default: 'default' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Select a cropping variant, in case multiple croppings have been specified or stored in FileReference + Select a cropping variant, in case multiple croppings have been specified or stored in FileReference -.. _typo3-fluid-media-fileextension: +.. _typo3-fluid-media-fileextension_argument: fileExtension ------------- -:aspect:`DataType` - string +.. confval:: fileExtension + :name: typo3-fluid-media-fileextension + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Custom file extension to use for images + Custom file extension to use for images -.. _typo3-fluid-media-loading: +.. _typo3-fluid-media-loading_argument: loading ------- -:aspect:`DataType` - string +.. confval:: loading + :name: typo3-fluid-media-loading + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Native lazy-loading for images property. Can be "lazy", "eager" or "auto". Used on image files only. + Native lazy-loading for images property. Can be "lazy", "eager" or "auto". Used on image files only. -.. _typo3-fluid-media-decoding: +.. _typo3-fluid-media-decoding_argument: decoding -------- -:aspect:`DataType` - string +.. confval:: decoding + :name: typo3-fluid-media-decoding + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Provides an image decoding hint to the browser. Can be "sync", "async" or "auto" + Provides an image decoding hint to the browser. Can be "sync", "async" or "auto" diff --git a/Documentation/typo3/fluid/latest/Render.rst b/Documentation/typo3/fluid/latest/Render.rst index c9f7218..d5bc8cb 100644 --- a/Documentation/typo3/fluid/latest/Render.rst +++ b/Documentation/typo3/fluid/latest/Render.rst @@ -1,128 +1,130 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/RenderViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/RenderViewHelper.php :navigation-title: render .. include:: /Includes.rst.txt .. _typo3-fluid-render: ============================== -render ViewHelper `` +Render ViewHelper `` ============================== +.. _typo3-fluid-render_source: + +Source code +=========== +Go to the source code of this ViewHelper: `RenderViewHelper.php (GitHub) `__. .. _typo3-fluid-render_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: -.. _typo3-fluid-render-section: + +.. _typo3-fluid-render-section_argument: section ------- -:aspect:`DataType` - string +.. confval:: section + :name: typo3-fluid-render-section + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Section to render - combine with partial to render section in partial + Section to render - combine with partial to render section in partial -.. _typo3-fluid-render-partial: +.. _typo3-fluid-render-partial_argument: partial ------- -:aspect:`DataType` - string +.. confval:: partial + :name: typo3-fluid-render-partial + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Partial to render, with or without section + Partial to render, with or without section -.. _typo3-fluid-render-delegate: +.. _typo3-fluid-render-delegate_argument: delegate -------- -:aspect:`DataType` - string +.. confval:: delegate + :name: typo3-fluid-render-delegate + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Optional PHP class name of a permanent, included-in-app ParsedTemplateInterface implementation to override partial/section + Optional PHP class name of a permanent, included-in-app ParsedTemplateInterface implementation to override partial/section -.. _typo3-fluid-render-arguments: +.. _typo3-fluid-render-arguments_argument: arguments --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: arguments + :name: typo3-fluid-render-arguments + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Array of variables to be transferred. Use {_all} for all variables + Array of variables to be transferred. Use {_all} for all variables -.. _typo3-fluid-render-optional: +.. _typo3-fluid-render-optional_argument: optional -------- -:aspect:`DataType` - boolean +.. confval:: optional + :name: typo3-fluid-render-optional + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, considers the *section* optional. Partial never is. + If TRUE, considers the *section* optional. Partial never is. -.. _typo3-fluid-render-default: +.. _typo3-fluid-render-default_argument: default ------- -:aspect:`DataType` - mixed +.. confval:: default + :name: typo3-fluid-render-default + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value (usually string) to be displayed if the section or partial does not exist + Value (usually string) to be displayed if the section or partial does not exist -.. _typo3-fluid-render-contentas: +.. _typo3-fluid-render-contentas_argument: contentAs --------- -:aspect:`DataType` - string +.. confval:: contentAs + :name: typo3-fluid-render-contentas + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If used, renders the child content and adds it as a template variable with this name for use in the partial/section + If used, renders the child content and adds it as a template variable with this name for use in the partial/section -.. _typo3-fluid-render-debug: +.. _typo3-fluid-render-debug_argument: debug ----- -:aspect:`DataType` - boolean - -:aspect:`Default` - true +.. confval:: debug + :name: typo3-fluid-render-debug + :type: boolean + :Default: true + :required: false -:aspect:`Required` - false -:aspect:`Description` - If true, the admin panel shows debug information if activated, + If true, the admin panel shows debug information if activated, diff --git a/Documentation/typo3/fluid/latest/Sanitize/Html.rst b/Documentation/typo3/fluid/latest/Sanitize/Html.rst index 14ff856..af8294e 100644 --- a/Documentation/typo3/fluid/latest/Sanitize/Html.rst +++ b/Documentation/typo3/fluid/latest/Sanitize/Html.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Sanitize/HtmlViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Sanitize/HtmlViewHelper.php :navigation-title: sanitize.html .. include:: /Includes.rst.txt .. _typo3-fluid-sanitize-html: ============================================ -sanitize.html ViewHelper `` +Sanitize.html ViewHelper `` ============================================ - Passes a given content through `typo3/html-sanitizer` to mitigate potential cross-site scripting occurrences. Given `default` build corresponds to class `TYPO3\CMS\Core\Html\DefaultSanitizerBuilder` declaring allowed HTML tags, @@ -36,25 +39,33 @@ Inline notation {richTextFieldContent -> f:sanitize.html(build: 'default')} +.. _typo3-fluid-sanitize-html_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `HtmlViewHelper.php (GitHub) `__. .. _typo3-fluid-sanitize-html_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-sanitize-html-build: +.. contents:: + :local: + + +.. _typo3-fluid-sanitize-html-build_argument: build ----- -:aspect:`DataType` - string - -:aspect:`Default` - 'default' +.. confval:: build + :name: typo3-fluid-sanitize-html-build + :type: string + :Default: 'default' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Preset name or class-like name of sanitization builder + Preset name or class-like name of sanitization builder diff --git a/Documentation/typo3/fluid/latest/Security/IfAuthenticated.rst b/Documentation/typo3/fluid/latest/Security/IfAuthenticated.rst index b37bbc3..1a212cb 100644 --- a/Documentation/typo3/fluid/latest/Security/IfAuthenticated.rst +++ b/Documentation/typo3/fluid/latest/Security/IfAuthenticated.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Security/IfAuthenticatedViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Security/IfAuthenticatedViewHelper.php :navigation-title: security.ifAuthenticated .. include:: /Includes.rst.txt .. _typo3-fluid-security-ifauthenticated: ================================================================== -security.ifAuthenticated ViewHelper `` +Security.ifAuthenticated ViewHelper `` ================================================================== - This ViewHelper implements an ifAuthenticated/else condition for frontend users. Examples @@ -42,35 +45,44 @@ IfAuthenticated / then / else Everything inside the :html:`` tag is displayed if frontend user is authenticated. Otherwise, everything inside the :html:`` tag is displayed. +.. _typo3-fluid-security-ifauthenticated_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IfAuthenticatedViewHelper.php (GitHub) `__. .. _typo3-fluid-security-ifauthenticated_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-security-ifauthenticated-then: +.. _typo3-fluid-security-ifauthenticated-then_argument: then ---- -:aspect:`DataType` - mixed +.. confval:: then + :name: typo3-fluid-security-ifauthenticated-then + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if met. + Value to be returned if the condition if met. -.. _typo3-fluid-security-ifauthenticated-else: +.. _typo3-fluid-security-ifauthenticated-else_argument: else ---- -:aspect:`DataType` - mixed +.. confval:: else + :name: typo3-fluid-security-ifauthenticated-else + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if not met. + Value to be returned if the condition if not met. diff --git a/Documentation/typo3/fluid/latest/Security/IfHasRole.rst b/Documentation/typo3/fluid/latest/Security/IfHasRole.rst index dd67336..703f0b3 100644 --- a/Documentation/typo3/fluid/latest/Security/IfHasRole.rst +++ b/Documentation/typo3/fluid/latest/Security/IfHasRole.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Security/IfHasRoleViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Security/IfHasRoleViewHelper.php :navigation-title: security.ifHasRole .. include:: /Includes.rst.txt .. _typo3-fluid-security-ifhasrole: ====================================================== -security.ifHasRole ViewHelper `` +Security.ifHasRole ViewHelper `` ====================================================== - This ViewHelper implements an ifHasRole/else condition for frontend groups. Examples @@ -56,48 +59,56 @@ IfRole / then / else Everything inside the :html:`` tag is displayed if the logged in FE user belongs to the specified role. Otherwise, everything inside the :html:`` tag is displayed. +.. _typo3-fluid-security-ifhasrole_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IfHasRoleViewHelper.php (GitHub) `__. .. _typo3-fluid-security-ifhasrole_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-security-ifhasrole-then: +.. _typo3-fluid-security-ifhasrole-then_argument: then ---- -:aspect:`DataType` - mixed +.. confval:: then + :name: typo3-fluid-security-ifhasrole-then + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if met. + Value to be returned if the condition if met. -.. _typo3-fluid-security-ifhasrole-else: +.. _typo3-fluid-security-ifhasrole-else_argument: else ---- -:aspect:`DataType` - mixed +.. confval:: else + :name: typo3-fluid-security-ifhasrole-else + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if not met. + Value to be returned if the condition if not met. -.. _typo3-fluid-security-ifhasrole-role: +.. _typo3-fluid-security-ifhasrole-role_argument: role ---- -:aspect:`DataType` - string +.. confval:: role + :name: typo3-fluid-security-ifhasrole-role + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The usergroup (either the usergroup uid or its title). + The usergroup (either the usergroup uid or its title). diff --git a/Documentation/typo3/fluid/latest/Security/Nonce.rst b/Documentation/typo3/fluid/latest/Security/Nonce.rst index 66924e2..0f9f07d 100644 --- a/Documentation/typo3/fluid/latest/Security/Nonce.rst +++ b/Documentation/typo3/fluid/latest/Security/Nonce.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Security/NonceViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Security/NonceViewHelper.php :navigation-title: security.nonce .. include:: /Includes.rst.txt .. _typo3-fluid-security-nonce: ============================================== -security.nonce ViewHelper `` +Security.nonce ViewHelper `` ============================================== - This ViewHelper resolves the `nonce` attribute from the global server request object, or from the `PolicyProvider` service as a fall-back value. @@ -21,11 +24,11 @@ Basic usage +.. _typo3-fluid-security-nonce_source: -.. _typo3-fluid-security-nonce_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `NonceViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3/fluid/latest/Transform/Html.rst b/Documentation/typo3/fluid/latest/Transform/Html.rst index dba682d..d2459eb 100644 --- a/Documentation/typo3/fluid/latest/Transform/Html.rst +++ b/Documentation/typo3/fluid/latest/Transform/Html.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Transform/HtmlViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Transform/HtmlViewHelper.php :navigation-title: transform.html .. include:: /Includes.rst.txt .. _typo3-fluid-transform-html: ============================================== -transform.html ViewHelper `` +Transform.html ViewHelper `` ============================================== - Transforms HTML and substitutes internal link scheme aspects. Examples @@ -33,41 +36,46 @@ Inline notation {content -> f:transform.html(selector:'a.href', onFailure:'removeEnclosure')} +.. _typo3-fluid-transform-html_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `HtmlViewHelper.php (GitHub) `__. .. _typo3-fluid-transform-html_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-transform-html-selector: +.. contents:: + :local: + + +.. _typo3-fluid-transform-html-selector_argument: selector -------- -:aspect:`DataType` - string +.. confval:: selector + :name: typo3-fluid-transform-html-selector + :type: string + :Default: 'a.href' + :required: false -:aspect:`Default` - 'a.href' + Comma separated list of node attributes to be considered -:aspect:`Required` - false -:aspect:`Description` - Comma separated list of node attributes to be considered - -.. _typo3-fluid-transform-html-onfailure: +.. _typo3-fluid-transform-html-onfailure_argument: onFailure --------- -:aspect:`DataType` - string - -:aspect:`Default` - 'removeEnclosure' +.. confval:: onFailure + :name: typo3-fluid-transform-html-onfailure + :type: string + :Default: 'removeEnclosure' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Behavior on failure, either `removeTag`, `removeAttr`, `removeEnclosure` or `null` + Behavior on failure, either `removeTag`, `removeAttr`, `removeEnclosure` or `null` diff --git a/Documentation/typo3/fluid/latest/Translate.rst b/Documentation/typo3/fluid/latest/Translate.rst index 1d0f746..588eb9d 100644 --- a/Documentation/typo3/fluid/latest/Translate.rst +++ b/Documentation/typo3/fluid/latest/Translate.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/TranslateViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/TranslateViewHelper.php :navigation-title: translate .. include:: /Includes.rst.txt .. _typo3-fluid-translate: ==================================== -translate ViewHelper `` +Translate ViewHelper `` ==================================== - Translate a key from locallang. The files are loaded from the folder :file:`Resources/Private/Language/`. @@ -89,100 +92,104 @@ The locallang file of extension "some_extension_name" will be used. .. _parseFunc: https://www.php.net/sprintf +.. _typo3-fluid-translate_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `TranslateViewHelper.php (GitHub) `__. .. _typo3-fluid-translate_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-translate-key: +.. _typo3-fluid-translate-key_argument: key --- -:aspect:`DataType` - string +.. confval:: key + :name: typo3-fluid-translate-key + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Translation Key + Translation Key -.. _typo3-fluid-translate-id: +.. _typo3-fluid-translate-id_argument: id -- -:aspect:`DataType` - string +.. confval:: id + :name: typo3-fluid-translate-id + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Translation ID. Same as key. + Translation ID. Same as key. -.. _typo3-fluid-translate-default: +.. _typo3-fluid-translate-default_argument: default ------- -:aspect:`DataType` - string +.. confval:: default + :name: typo3-fluid-translate-default + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If the given locallang key could not be found, this value is used. If this argument is not set, child nodes will be used to render the default + If the given locallang key could not be found, this value is used. If this argument is not set, child nodes will be used to render the default -.. _typo3-fluid-translate-arguments: +.. _typo3-fluid-translate-arguments_argument: arguments --------- -:aspect:`DataType` - mixed +.. confval:: arguments + :name: typo3-fluid-translate-arguments + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments to be replaced in the resulting string + Arguments to be replaced in the resulting string -.. _typo3-fluid-translate-extensionname: +.. _typo3-fluid-translate-extensionname_argument: extensionName ------------- -:aspect:`DataType` - string +.. confval:: extensionName + :name: typo3-fluid-translate-extensionname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - UpperCamelCased extension key (for example BlogExample) + UpperCamelCased extension key (for example BlogExample) -.. _typo3-fluid-translate-languagekey: +.. _typo3-fluid-translate-languagekey_argument: languageKey ----------- -:aspect:`DataType` - string +.. confval:: languageKey + :name: typo3-fluid-translate-languagekey + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Language key ("da" for example) or "default" to use. Also a Locale object is possible. If empty, use current locale from the request. + Language key ("da" for example) or "default" to use. Also a Locale object is possible. If empty, use current locale from the request. -.. _typo3-fluid-translate-alternativelanguagekeys: +.. _typo3-fluid-translate-alternativelanguagekeys_argument: alternativeLanguageKeys ----------------------- -:aspect:`DataType` - mixed +.. confval:: alternativeLanguageKeys + :name: typo3-fluid-translate-alternativelanguagekeys + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Alternative language keys if no translation does exist. Ignored in non-extbase context. Deprecated, will be removed in TYPO3 v13.0 + Alternative language keys if no translation does exist. Ignored in non-extbase context. Deprecated, will be removed in TYPO3 v13.0 diff --git a/Documentation/typo3/fluid/latest/Uri/Action.rst b/Documentation/typo3/fluid/latest/Uri/Action.rst index 668ff1a..21d48d9 100644 --- a/Documentation/typo3/fluid/latest/Uri/Action.rst +++ b/Documentation/typo3/fluid/latest/Uri/Action.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/ActionViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/ActionViewHelper.php :navigation-title: uri.action .. include:: /Includes.rst.txt .. _typo3-fluid-uri-action: ====================================== -uri.action ViewHelper `` +Uri.action ViewHelper `` ====================================== - A ViewHelper for creating URIs to extbase actions. Tailored for extbase plugins, uses extbase Request and extbase UriBuilder. Examples @@ -21,226 +24,215 @@ URI to the show-action of the current controller:: Depending on current page, routing and page path configuration. +.. _typo3-fluid-uri-action_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ActionViewHelper.php (GitHub) `__. .. _typo3-fluid-uri-action_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: -.. _typo3-fluid-uri-action-action: + +.. _typo3-fluid-uri-action-action_argument: action ------ -:aspect:`DataType` - string +.. confval:: action + :name: typo3-fluid-uri-action-action + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target action + Target action -.. _typo3-fluid-uri-action-arguments: +.. _typo3-fluid-uri-action-arguments_argument: arguments --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: arguments + :name: typo3-fluid-uri-action-arguments + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments + Arguments -.. _typo3-fluid-uri-action-controller: +.. _typo3-fluid-uri-action-controller_argument: controller ---------- -:aspect:`DataType` - string +.. confval:: controller + :name: typo3-fluid-uri-action-controller + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target controller. If NULL current controllerName is used + Target controller. If NULL current controllerName is used -.. _typo3-fluid-uri-action-extensionname: +.. _typo3-fluid-uri-action-extensionname_argument: extensionName ------------- -:aspect:`DataType` - string +.. confval:: extensionName + :name: typo3-fluid-uri-action-extensionname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target Extension Name (without `tx_` prefix and no underscores). If NULL the current extension name is used + Target Extension Name (without `tx_` prefix and no underscores). If NULL the current extension name is used -.. _typo3-fluid-uri-action-pluginname: +.. _typo3-fluid-uri-action-pluginname_argument: pluginName ---------- -:aspect:`DataType` - string +.. confval:: pluginName + :name: typo3-fluid-uri-action-pluginname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target plugin. If empty, the current plugin name is used + Target plugin. If empty, the current plugin name is used -.. _typo3-fluid-uri-action-pageuid: +.. _typo3-fluid-uri-action-pageuid_argument: pageUid ------- -:aspect:`DataType` - mixed +.. confval:: pageUid + :name: typo3-fluid-uri-action-pageuid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target page. See TypoLink destination + Target page. See TypoLink destination -.. _typo3-fluid-uri-action-pagetype: +.. _typo3-fluid-uri-action-pagetype_argument: pageType -------- -:aspect:`DataType` - mixed +.. confval:: pageType + :name: typo3-fluid-uri-action-pagetype + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Type of the target page. See typolink.parameter + Type of the target page. See typolink.parameter -.. _typo3-fluid-uri-action-nocache: +.. _typo3-fluid-uri-action-nocache_argument: noCache ------- -:aspect:`DataType` - boolean +.. confval:: noCache + :name: typo3-fluid-uri-action-nocache + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Set this to disable caching for the target page. You should not need this. + Set this to disable caching for the target page. You should not need this. -.. _typo3-fluid-uri-action-language: +.. _typo3-fluid-uri-action-language_argument: language -------- -:aspect:`DataType` - string +.. confval:: language + :name: typo3-fluid-uri-action-language + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language + Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language -.. _typo3-fluid-uri-action-section: +.. _typo3-fluid-uri-action-section_argument: section ------- -:aspect:`DataType` - string +.. confval:: section + :name: typo3-fluid-uri-action-section + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The anchor to be added to the URI + The anchor to be added to the URI -.. _typo3-fluid-uri-action-format: +.. _typo3-fluid-uri-action-format_argument: format ------ -:aspect:`DataType` - string +.. confval:: format + :name: typo3-fluid-uri-action-format + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The requested format, e.g. ".html + The requested format, e.g. ".html -.. _typo3-fluid-uri-action-linkaccessrestrictedpages: +.. _typo3-fluid-uri-action-linkaccessrestrictedpages_argument: linkAccessRestrictedPages ------------------------- -:aspect:`DataType` - boolean +.. confval:: linkAccessRestrictedPages + :name: typo3-fluid-uri-action-linkaccessrestrictedpages + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed. + If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed. -.. _typo3-fluid-uri-action-additionalparams: +.. _typo3-fluid-uri-action-additionalparams_argument: additionalParams ---------------- -:aspect:`DataType` - mixed +.. confval:: additionalParams + :name: typo3-fluid-uri-action-additionalparams + :type: mixed + :Default: array () + :required: false -:aspect:`Default` - array () + Additional query parameters that won't be prefixed like $arguments (overrule $arguments) -:aspect:`Required` - false -:aspect:`Description` - Additional query parameters that won't be prefixed like $arguments (overrule $arguments) - -.. _typo3-fluid-uri-action-absolute: +.. _typo3-fluid-uri-action-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-uri-action-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, an absolute URI is rendered + If set, an absolute URI is rendered -.. _typo3-fluid-uri-action-addquerystring: +.. _typo3-fluid-uri-action-addquerystring_argument: addQueryString -------------- -:aspect:`DataType` - string +.. confval:: addQueryString + :name: typo3-fluid-uri-action-addquerystring + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. + If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. -.. _typo3-fluid-uri-action-argumentstobeexcludedfromquerystring: +.. _typo3-fluid-uri-action-argumentstobeexcludedfromquerystring_argument: argumentsToBeExcludedFromQueryString ------------------------------------ -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: argumentsToBeExcludedFromQueryString + :name: typo3-fluid-uri-action-argumentstobeexcludedfromquerystring + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments to be removed from the URI. Only active if $addQueryString = TRUE + Arguments to be removed from the URI. Only active if $addQueryString = TRUE diff --git a/Documentation/typo3/fluid/latest/Uri/External.rst b/Documentation/typo3/fluid/latest/Uri/External.rst index c011ca0..eb0e6d6 100644 --- a/Documentation/typo3/fluid/latest/Uri/External.rst +++ b/Documentation/typo3/fluid/latest/Uri/External.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/ExternalViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/ExternalViewHelper.php :navigation-title: uri.external .. include:: /Includes.rst.txt .. _typo3-fluid-uri-external: ========================================== -uri.external ViewHelper `` +Uri.external ViewHelper `` ========================================== - A ViewHelper for creating URIs to external targets. Currently the specified URI is simply passed through. @@ -32,38 +35,45 @@ Custom default scheme ``ftp://typo3.org`` +.. _typo3-fluid-uri-external_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ExternalViewHelper.php (GitHub) `__. .. _typo3-fluid-uri-external_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-uri-external-uri: +.. contents:: + :local: + + +.. _typo3-fluid-uri-external-uri_argument: uri --- -:aspect:`DataType` - string +.. confval:: uri + :name: typo3-fluid-uri-external-uri + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Target URI + Target URI -.. _typo3-fluid-uri-external-defaultscheme: +.. _typo3-fluid-uri-external-defaultscheme_argument: defaultScheme ------------- -:aspect:`DataType` - string - -:aspect:`Default` - 'https' +.. confval:: defaultScheme + :name: typo3-fluid-uri-external-defaultscheme + :type: string + :Default: 'https' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Scheme the href attribute will be prefixed with if specified $uri does not contain a scheme already + Scheme the href attribute will be prefixed with if specified $uri does not contain a scheme already diff --git a/Documentation/typo3/fluid/latest/Uri/Image.rst b/Documentation/typo3/fluid/latest/Uri/Image.rst index bf0aa4a..d1ff42d 100644 --- a/Documentation/typo3/fluid/latest/Uri/Image.rst +++ b/Documentation/typo3/fluid/latest/Uri/Image.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/ImageViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/ImageViewHelper.php :navigation-title: uri.image .. include:: /Includes.rst.txt .. _typo3-fluid-uri-image: ==================================== -uri.image ViewHelper `` +Uri.image ViewHelper `` ==================================== - Resizes a given image (if required) and returns its relative path. This ViewHelper should only be used for images within FAL storages, @@ -81,181 +84,177 @@ Non existing image ``Could not get image resource for "NonExistingImage.png".`` +.. _typo3-fluid-uri-image_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ImageViewHelper.php (GitHub) `__. .. _typo3-fluid-uri-image_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-uri-image-src: +.. contents:: + :local: + + +.. _typo3-fluid-uri-image-src_argument: src --- -:aspect:`DataType` - string +.. confval:: src + :name: typo3-fluid-uri-image-src + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Src + Src -.. _typo3-fluid-uri-image-treatidasreference: +.. _typo3-fluid-uri-image-treatidasreference_argument: treatIdAsReference ------------------ -:aspect:`DataType` - boolean +.. confval:: treatIdAsReference + :name: typo3-fluid-uri-image-treatidasreference + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Given src argument is a sys_file_reference record + Given src argument is a sys_file_reference record -.. _typo3-fluid-uri-image-image: +.. _typo3-fluid-uri-image-image_argument: image ----- -:aspect:`DataType` - mixed +.. confval:: image + :name: typo3-fluid-uri-image-image + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Image + Image -.. _typo3-fluid-uri-image-crop: +.. _typo3-fluid-uri-image-crop_argument: crop ---- -:aspect:`DataType` - mixed +.. confval:: crop + :name: typo3-fluid-uri-image-crop + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Overrule cropping of image (setting to FALSE disables the cropping set in FileReference) + Overrule cropping of image (setting to FALSE disables the cropping set in FileReference) -.. _typo3-fluid-uri-image-cropvariant: +.. _typo3-fluid-uri-image-cropvariant_argument: cropVariant ----------- -:aspect:`DataType` - string - -:aspect:`Default` - 'default' +.. confval:: cropVariant + :name: typo3-fluid-uri-image-cropvariant + :type: string + :Default: 'default' + :required: false -:aspect:`Required` - false -:aspect:`Description` - Select a cropping variant, in case multiple croppings have been specified or stored in FileReference + Select a cropping variant, in case multiple croppings have been specified or stored in FileReference -.. _typo3-fluid-uri-image-fileextension: +.. _typo3-fluid-uri-image-fileextension_argument: fileExtension ------------- -:aspect:`DataType` - string +.. confval:: fileExtension + :name: typo3-fluid-uri-image-fileextension + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Custom file extension to use + Custom file extension to use -.. _typo3-fluid-uri-image-width: +.. _typo3-fluid-uri-image-width_argument: width ----- -:aspect:`DataType` - string +.. confval:: width + :name: typo3-fluid-uri-image-width + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. + Width of the image. This can be a numeric value representing the fixed width of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. -.. _typo3-fluid-uri-image-height: +.. _typo3-fluid-uri-image-height_argument: height ------ -:aspect:`DataType` - string +.. confval:: height + :name: typo3-fluid-uri-image-height + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. + Height of the image. This can be a numeric value representing the fixed height of the image in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options. -.. _typo3-fluid-uri-image-minwidth: +.. _typo3-fluid-uri-image-minwidth_argument: minWidth -------- -:aspect:`DataType` - mixed +.. confval:: minWidth + :name: typo3-fluid-uri-image-minwidth + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Minimum width of the image + Minimum width of the image -.. _typo3-fluid-uri-image-minheight: +.. _typo3-fluid-uri-image-minheight_argument: minHeight --------- -:aspect:`DataType` - mixed +.. confval:: minHeight + :name: typo3-fluid-uri-image-minheight + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Minimum height of the image + Minimum height of the image -.. _typo3-fluid-uri-image-maxwidth: +.. _typo3-fluid-uri-image-maxwidth_argument: maxWidth -------- -:aspect:`DataType` - mixed +.. confval:: maxWidth + :name: typo3-fluid-uri-image-maxwidth + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Maximum width of the image + Maximum width of the image -.. _typo3-fluid-uri-image-maxheight: +.. _typo3-fluid-uri-image-maxheight_argument: maxHeight --------- -:aspect:`DataType` - mixed +.. confval:: maxHeight + :name: typo3-fluid-uri-image-maxheight + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Maximum height of the image + Maximum height of the image -.. _typo3-fluid-uri-image-absolute: +.. _typo3-fluid-uri-image-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-uri-image-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Force absolute URL + Force absolute URL diff --git a/Documentation/typo3/fluid/latest/Uri/Page.rst b/Documentation/typo3/fluid/latest/Uri/Page.rst index 49f0554..dd9e52f 100644 --- a/Documentation/typo3/fluid/latest/Uri/Page.rst +++ b/Documentation/typo3/fluid/latest/Uri/Page.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/PageViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/PageViewHelper.php :navigation-title: uri.page .. include:: /Includes.rst.txt .. _typo3-fluid-uri-page: ================================== -uri.page ViewHelper `` +Uri.page ViewHelper `` ================================== - A ViewHelper for creating URIs to TYPO3 pages. Examples @@ -46,145 +49,142 @@ Query parameters for extensions Depending on current page, routing and page path configuration. +.. _typo3-fluid-uri-page_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `PageViewHelper.php (GitHub) `__. .. _typo3-fluid-uri-page_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3-fluid-uri-page-pageuid: +.. contents:: + :local: + + +.. _typo3-fluid-uri-page-pageuid_argument: pageUid ------- -:aspect:`DataType` - mixed +.. confval:: pageUid + :name: typo3-fluid-uri-page-pageuid + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target PID + Target PID -.. _typo3-fluid-uri-page-additionalparams: +.. _typo3-fluid-uri-page-additionalparams_argument: additionalParams ---------------- -:aspect:`DataType` - mixed +.. confval:: additionalParams + :name: typo3-fluid-uri-page-additionalparams + :type: mixed + :Default: array () + :required: false -:aspect:`Default` - array () + Query parameters to be attached to the resulting URI -:aspect:`Required` - false -:aspect:`Description` - Query parameters to be attached to the resulting URI - -.. _typo3-fluid-uri-page-pagetype: +.. _typo3-fluid-uri-page-pagetype_argument: pageType -------- -:aspect:`DataType` - mixed +.. confval:: pageType + :name: typo3-fluid-uri-page-pagetype + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Type of the target page. See typolink.parameter + Type of the target page. See typolink.parameter -.. _typo3-fluid-uri-page-nocache: +.. _typo3-fluid-uri-page-nocache_argument: noCache ------- -:aspect:`DataType` - boolean +.. confval:: noCache + :name: typo3-fluid-uri-page-nocache + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Set this to disable caching for the target page. You should not need this. + Set this to disable caching for the target page. You should not need this. -.. _typo3-fluid-uri-page-language: +.. _typo3-fluid-uri-page-language_argument: language -------- -:aspect:`DataType` - string +.. confval:: language + :name: typo3-fluid-uri-page-language + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language + Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language -.. _typo3-fluid-uri-page-section: +.. _typo3-fluid-uri-page-section_argument: section ------- -:aspect:`DataType` - string +.. confval:: section + :name: typo3-fluid-uri-page-section + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The anchor to be added to the URI + The anchor to be added to the URI -.. _typo3-fluid-uri-page-linkaccessrestrictedpages: +.. _typo3-fluid-uri-page-linkaccessrestrictedpages_argument: linkAccessRestrictedPages ------------------------- -:aspect:`DataType` - boolean +.. confval:: linkAccessRestrictedPages + :name: typo3-fluid-uri-page-linkaccessrestrictedpages + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed. + If set, links pointing to access restricted pages will still link to the page even though the page cannot be accessed. -.. _typo3-fluid-uri-page-absolute: +.. _typo3-fluid-uri-page-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-uri-page-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the URI of the rendered link is absolute + If set, the URI of the rendered link is absolute -.. _typo3-fluid-uri-page-addquerystring: +.. _typo3-fluid-uri-page-addquerystring_argument: addQueryString -------------- -:aspect:`DataType` - string +.. confval:: addQueryString + :name: typo3-fluid-uri-page-addquerystring + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. + If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. -.. _typo3-fluid-uri-page-argumentstobeexcludedfromquerystring: +.. _typo3-fluid-uri-page-argumentstobeexcludedfromquerystring_argument: argumentsToBeExcludedFromQueryString ------------------------------------ -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: argumentsToBeExcludedFromQueryString + :name: typo3-fluid-uri-page-argumentstobeexcludedfromquerystring + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments to be removed from the URI. Only active if $addQueryString = TRUE + Arguments to be removed from the URI. Only active if $addQueryString = TRUE diff --git a/Documentation/typo3/fluid/latest/Uri/Resource.rst b/Documentation/typo3/fluid/latest/Uri/Resource.rst index 46ec39c..8ac7b12 100644 --- a/Documentation/typo3/fluid/latest/Uri/Resource.rst +++ b/Documentation/typo3/fluid/latest/Uri/Resource.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/ResourceViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/ResourceViewHelper.php :navigation-title: uri.resource .. include:: /Includes.rst.txt .. _typo3-fluid-uri-resource: ========================================== -uri.resource ViewHelper `` +Uri.resource ViewHelper `` ========================================== - A ViewHelper for creating URIs to resources. This ViewHelper should be used for extension resource files. @@ -57,48 +60,56 @@ Output:: Magically adds 'Resources/Public' to path. +.. _typo3-fluid-uri-resource_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ResourceViewHelper.php (GitHub) `__. .. _typo3-fluid-uri-resource_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-uri-resource-path: +.. _typo3-fluid-uri-resource-path_argument: path ---- -:aspect:`DataType` - string +.. confval:: path + :name: typo3-fluid-uri-resource-path + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The path and filename of the resource (relative to Public resource directory of the extension). + The path and filename of the resource (relative to Public resource directory of the extension). -.. _typo3-fluid-uri-resource-extensionname: +.. _typo3-fluid-uri-resource-extensionname_argument: extensionName ------------- -:aspect:`DataType` - string +.. confval:: extensionName + :name: typo3-fluid-uri-resource-extensionname + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Target extension name. If not set, the current extension name will be used + Target extension name. If not set, the current extension name will be used -.. _typo3-fluid-uri-resource-absolute: +.. _typo3-fluid-uri-resource-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-uri-resource-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, an absolute URI is rendered + If set, an absolute URI is rendered diff --git a/Documentation/typo3/fluid/latest/Uri/Typolink.rst b/Documentation/typo3/fluid/latest/Uri/Typolink.rst index f6a7d70..80a6db4 100644 --- a/Documentation/typo3/fluid/latest/Uri/Typolink.rst +++ b/Documentation/typo3/fluid/latest/Uri/Typolink.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/typo3/blob/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/TypolinkViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/typo3/edit/main/typo3/sysext/fluid/Classes/ViewHelpers/Uri/TypolinkViewHelper.php :navigation-title: uri.typolink .. include:: /Includes.rst.txt .. _typo3-fluid-uri-typolink: ========================================== -uri.typolink ViewHelper `` +Uri.typolink ViewHelper `` ========================================== - A ViewHelper to create uris from fields supported by the link wizard. Example @@ -41,87 +44,92 @@ Full parameter usage Depending on routing and page path configuration. +.. _typo3-fluid-uri-typolink_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `TypolinkViewHelper.php (GitHub) `__. .. _typo3-fluid-uri-typolink_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3-fluid-uri-typolink-parameter: +.. _typo3-fluid-uri-typolink-parameter_argument: parameter --------- -:aspect:`DataType` - string +.. confval:: parameter + :name: typo3-fluid-uri-typolink-parameter + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - StdWrap.typolink style parameter string + StdWrap.typolink style parameter string -.. _typo3-fluid-uri-typolink-additionalparams: +.. _typo3-fluid-uri-typolink-additionalparams_argument: additionalParams ---------------- -:aspect:`DataType` - string +.. confval:: additionalParams + :name: typo3-fluid-uri-typolink-additionalparams + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - StdWrap.typolink additionalParams + StdWrap.typolink additionalParams -.. _typo3-fluid-uri-typolink-language: +.. _typo3-fluid-uri-typolink-language_argument: language -------- -:aspect:`DataType` - string +.. confval:: language + :name: typo3-fluid-uri-typolink-language + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language + Link to a specific language - defaults to the current language, use a language ID or "current" to enforce a specific language -.. _typo3-fluid-uri-typolink-addquerystring: +.. _typo3-fluid-uri-typolink-addquerystring_argument: addQueryString -------------- -:aspect:`DataType` - string +.. confval:: addQueryString + :name: typo3-fluid-uri-typolink-addquerystring + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. + If set, the current query parameters will be kept in the URL. If set to "untrusted", then ALL query parameters will be added. Be aware, that this might lead to problems when the generated link is cached. -.. _typo3-fluid-uri-typolink-addquerystringexclude: +.. _typo3-fluid-uri-typolink-addquerystringexclude_argument: addQueryStringExclude --------------------- -:aspect:`DataType` - string +.. confval:: addQueryStringExclude + :name: typo3-fluid-uri-typolink-addquerystringexclude + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Define parameters to be excluded from the query string (only active if addQueryString is set) + Define parameters to be excluded from the query string (only active if addQueryString is set) -.. _typo3-fluid-uri-typolink-absolute: +.. _typo3-fluid-uri-typolink-absolute_argument: absolute -------- -:aspect:`DataType` - boolean +.. confval:: absolute + :name: typo3-fluid-uri-typolink-absolute + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Ensure the resulting URL is an absolute URL + Ensure the resulting URL is an absolute URL diff --git a/Documentation/typo3fluid/fluid/latest/Alias.rst b/Documentation/typo3fluid/fluid/latest/Alias.rst index 6b8c30d..ca4f1aa 100644 --- a/Documentation/typo3fluid/fluid/latest/Alias.rst +++ b/Documentation/typo3fluid/fluid/latest/Alias.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/AliasViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/AliasViewHelper.php :navigation-title: alias .. include:: /Includes.rst.txt .. _typo3fluid-fluid-alias: ============================ -alias ViewHelper `` +Alias ViewHelper `` ============================ - Declares new variables which are aliases of other variables. Takes a "map"-Parameter which is an associative array which defines the shorthand mapping. @@ -47,22 +50,32 @@ Output:: Depending on ``{foo.bar.baz}``. +.. _typo3fluid-fluid-alias_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `AliasViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-alias_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-alias-map: +.. _typo3fluid-fluid-alias-map_argument: map --- -:aspect:`DataType` - mixed +.. confval:: map + :name: typo3fluid-fluid-alias-map + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Array that specifies which variables should be mapped to which alias + Array that specifies which variables should be mapped to which alias diff --git a/Documentation/typo3fluid/fluid/latest/Cache/Disable.rst b/Documentation/typo3fluid/fluid/latest/Cache/Disable.rst index 5e0043b..0e8bb99 100644 --- a/Documentation/typo3fluid/fluid/latest/Cache/Disable.rst +++ b/Documentation/typo3fluid/fluid/latest/Cache/Disable.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/Cache/DisableViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/Cache/DisableViewHelper.php :navigation-title: cache.disable .. include:: /Includes.rst.txt .. _typo3fluid-fluid-cache-disable: ============================================ -cache.disable ViewHelper `` +Cache.disable ViewHelper `` ============================================ - ViewHelper to disable template compiling Inserting this ViewHelper at any point in the template, @@ -53,11 +56,11 @@ Container tag Additional output is also not compilable because of the ViewHelper +.. _typo3fluid-fluid-cache-disable_source: -.. _typo3fluid-fluid-cache-disable_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `DisableViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3fluid/fluid/latest/Cache/Static.rst b/Documentation/typo3fluid/fluid/latest/Cache/Static.rst index 13937cf..eb2d154 100644 --- a/Documentation/typo3fluid/fluid/latest/Cache/Static.rst +++ b/Documentation/typo3fluid/fluid/latest/Cache/Static.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/Cache/StaticViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/Cache/StaticViewHelper.php :navigation-title: cache.static .. include:: /Includes.rst.txt .. _typo3fluid-fluid-cache-static: ========================================== -cache.static ViewHelper `` +Cache.static ViewHelper `` ========================================== - ViewHelper to force compiling to a static string Used around chunks of template code where you want the @@ -61,11 +64,11 @@ This is also evaluated when compiled (static node is closed):: Also evaluated; is outside static node +.. _typo3fluid-fluid-cache-static_source: -.. _typo3fluid-fluid-cache-static_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `StaticViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3fluid/fluid/latest/Cache/Warmup.rst b/Documentation/typo3fluid/fluid/latest/Cache/Warmup.rst index 59949a4..9a89ef5 100644 --- a/Documentation/typo3fluid/fluid/latest/Cache/Warmup.rst +++ b/Documentation/typo3fluid/fluid/latest/Cache/Warmup.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/Cache/WarmupViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/Cache/WarmupViewHelper.php :navigation-title: cache.warmup .. include:: /Includes.rst.txt .. _typo3fluid-fluid-cache-warmup: ========================================== -cache.warmup ViewHelper `` +Cache.warmup ViewHelper `` ========================================== - ViewHelper to insert variables which only apply during cache warmup and only apply if no other variables are specified for the warmup process. @@ -52,25 +55,33 @@ Usage and effect assignment only happens if Fluid is in warmup mode. +.. _typo3fluid-fluid-cache-warmup_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `WarmupViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-cache-warmup_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3fluid-fluid-cache-warmup-variables: +.. contents:: + :local: + + +.. _typo3fluid-fluid-cache-warmup-variables_argument: variables --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: variables + :name: typo3fluid-fluid-cache-warmup-variables + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Array of variables to assign ONLY when compiling. See main class documentation. + Array of variables to assign ONLY when compiling. See main class documentation. diff --git a/Documentation/typo3fluid/fluid/latest/Case.rst b/Documentation/typo3fluid/fluid/latest/Case.rst index 1871daf..1268eb7 100644 --- a/Documentation/typo3fluid/fluid/latest/Case.rst +++ b/Documentation/typo3fluid/fluid/latest/Case.rst @@ -1,31 +1,44 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/CaseViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/CaseViewHelper.php :navigation-title: case .. include:: /Includes.rst.txt .. _typo3fluid-fluid-case: ========================== -case ViewHelper `` +Case ViewHelper `` ========================== - Case ViewHelper that is only usable within the ``f:switch`` ViewHelper. +.. _typo3fluid-fluid-case_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CaseViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-case_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-case-value: +.. _typo3fluid-fluid-case-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3fluid-fluid-case-value + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Value to match in this case + Value to match in this case diff --git a/Documentation/typo3fluid/fluid/latest/Comment.rst b/Documentation/typo3fluid/fluid/latest/Comment.rst index 33bd962..d1b5861 100644 --- a/Documentation/typo3fluid/fluid/latest/Comment.rst +++ b/Documentation/typo3fluid/fluid/latest/Comment.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/CommentViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/CommentViewHelper.php :navigation-title: comment .. include:: /Includes.rst.txt .. _typo3fluid-fluid-comment: ================================ -comment ViewHelper `` +Comment ViewHelper `` ================================ - This ViewHelper prevents rendering of any content inside the tag. Contents of the comment will still be **parsed** thus throwing an @@ -53,11 +56,11 @@ Output: Will be nothing. +.. _typo3fluid-fluid-comment_source: -.. _typo3fluid-fluid-comment_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `CommentViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3fluid/fluid/latest/Count.rst b/Documentation/typo3fluid/fluid/latest/Count.rst index 27c4740..67205e5 100644 --- a/Documentation/typo3fluid/fluid/latest/Count.rst +++ b/Documentation/typo3fluid/fluid/latest/Count.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/CountViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/CountViewHelper.php :navigation-title: count .. include:: /Includes.rst.txt .. _typo3fluid-fluid-count: ============================ -count ViewHelper `` +Count ViewHelper `` ============================ - This ViewHelper counts elements of the specified array or countable object. Examples @@ -35,22 +38,32 @@ Output:: 10 (depending on the number of items in ``{objects}``) +.. _typo3fluid-fluid-count_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CountViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-count_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-count-subject: +.. _typo3fluid-fluid-count-subject_argument: subject ------- -:aspect:`DataType` - mixed +.. confval:: subject + :name: typo3fluid-fluid-count-subject + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Countable subject, array or \Countable + Countable subject, array or \Countable diff --git a/Documentation/typo3fluid/fluid/latest/Cycle.rst b/Documentation/typo3fluid/fluid/latest/Cycle.rst index 9e2a588..2d4738a 100644 --- a/Documentation/typo3fluid/fluid/latest/Cycle.rst +++ b/Documentation/typo3fluid/fluid/latest/Cycle.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/CycleViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/CycleViewHelper.php :navigation-title: cycle .. include:: /Includes.rst.txt .. _typo3fluid-fluid-cycle: ============================ -cycle ViewHelper `` +Cycle ViewHelper `` ============================ - This ViewHelper cycles through the specified values. This can be often used to specify CSS classes for example. @@ -57,35 +60,44 @@ Output::
  • 4
    • +.. _typo3fluid-fluid-cycle_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CycleViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-cycle_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-cycle-values: +.. _typo3fluid-fluid-cycle-values_argument: values ------ -:aspect:`DataType` - mixed +.. confval:: values + :name: typo3fluid-fluid-cycle-values + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The array or object implementing \ArrayAccess (for example \SplObjectStorage) to iterated over + The array or object implementing \ArrayAccess (for example \SplObjectStorage) to iterated over -.. _typo3fluid-fluid-cycle-as: +.. _typo3fluid-fluid-cycle-as_argument: as -- -:aspect:`DataType` - mixed +.. confval:: as + :name: typo3fluid-fluid-cycle-as + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - The name of the iteration variable + The name of the iteration variable diff --git a/Documentation/typo3fluid/fluid/latest/Debug.rst b/Documentation/typo3fluid/fluid/latest/Debug.rst index 2822bae..b7fa6f5 100644 --- a/Documentation/typo3fluid/fluid/latest/Debug.rst +++ b/Documentation/typo3fluid/fluid/latest/Debug.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/DebugViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/DebugViewHelper.php :navigation-title: debug .. include:: /Includes.rst.txt .. _typo3fluid-fluid-debug: ============================ -debug ViewHelper `` +Debug ViewHelper `` ============================ - This ViewHelper is only meant to be used during development. Examples @@ -35,51 +38,57 @@ Output:: the type or class name of {object} +.. _typo3fluid-fluid-debug_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `DebugViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-debug_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3fluid-fluid-debug-typeonly: +.. contents:: + :local: + + +.. _typo3fluid-fluid-debug-typeonly_argument: typeOnly -------- -:aspect:`DataType` - boolean +.. confval:: typeOnly + :name: typo3fluid-fluid-debug-typeonly + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, debugs only the type of variables + If TRUE, debugs only the type of variables -.. _typo3fluid-fluid-debug-levels: +.. _typo3fluid-fluid-debug-levels_argument: levels ------ -:aspect:`DataType` - integer - -:aspect:`Default` - 5 +.. confval:: levels + :name: typo3fluid-fluid-debug-levels + :type: integer + :Default: 5 + :required: false -:aspect:`Required` - false -:aspect:`Description` - Levels to render when rendering nested objects/arrays + Levels to render when rendering nested objects/arrays -.. _typo3fluid-fluid-debug-html: +.. _typo3fluid-fluid-debug-html_argument: html ---- -:aspect:`DataType` - boolean +.. confval:: html + :name: typo3fluid-fluid-debug-html + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Render HTML. If FALSE, output is indented plaintext + Render HTML. If FALSE, output is indented plaintext diff --git a/Documentation/typo3fluid/fluid/latest/DefaultCase.rst b/Documentation/typo3fluid/fluid/latest/DefaultCase.rst index d92ba8f..2285763 100644 --- a/Documentation/typo3fluid/fluid/latest/DefaultCase.rst +++ b/Documentation/typo3fluid/fluid/latest/DefaultCase.rst @@ -1,20 +1,23 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/DefaultCaseViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/DefaultCaseViewHelper.php :navigation-title: defaultCase .. include:: /Includes.rst.txt .. _typo3fluid-fluid-defaultcase: ======================================== -defaultCase ViewHelper `` +DefaultCase ViewHelper `` ======================================== - A ViewHelper which specifies the "default" case when used within the ``f:switch`` ViewHelper. +.. _typo3fluid-fluid-defaultcase_source: -.. _typo3fluid-fluid-defaultcase_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `DefaultCaseViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3fluid/fluid/latest/Else.rst b/Documentation/typo3fluid/fluid/latest/Else.rst index d6a70f5..302bc25 100644 --- a/Documentation/typo3fluid/fluid/latest/Else.rst +++ b/Documentation/typo3fluid/fluid/latest/Else.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/ElseViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/ElseViewHelper.php :navigation-title: else .. include:: /Includes.rst.txt .. _typo3fluid-fluid-else: ========================== -else ViewHelper `` +Else ViewHelper `` ========================== - Else-Branch of a condition. Only has an effect inside of ``f:if``. See the ``f:if`` ViewHelper for documentation. @@ -30,22 +33,32 @@ Output:: Everything inside the "else" tag is displayed if the condition evaluates to FALSE. Otherwise nothing is outputted in this example. +.. _typo3fluid-fluid-else_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ElseViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-else_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-else-if: +.. _typo3fluid-fluid-else-if_argument: if -- -:aspect:`DataType` - boolean +.. confval:: if + :name: typo3fluid-fluid-else-if + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Condition expression conforming to Fluid boolean rules + Condition expression conforming to Fluid boolean rules diff --git a/Documentation/typo3fluid/fluid/latest/For.rst b/Documentation/typo3fluid/fluid/latest/For.rst index 771176e..2e1756f 100644 --- a/Documentation/typo3fluid/fluid/latest/For.rst +++ b/Documentation/typo3fluid/fluid/latest/For.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/ForViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/ForViewHelper.php :navigation-title: for .. include:: /Includes.rst.txt .. _typo3fluid-fluid-for: ======================== -for ViewHelper `` +For ViewHelper `` ======================== - Loop ViewHelper which can be used to iterate over arrays. Implements what a basic PHP ``foreach()`` does. @@ -67,74 +70,80 @@ Output::
  • Index: 3 Cycle: 4 Total: 4 Even Last
    • +.. _typo3fluid-fluid-for_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `ForViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-for_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-for-each: +.. _typo3fluid-fluid-for-each_argument: each ---- -:aspect:`DataType` - mixed +.. confval:: each + :name: typo3fluid-fluid-for-each + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - The array or \SplObjectStorage to iterated over + The array or \SplObjectStorage to iterated over -.. _typo3fluid-fluid-for-as: +.. _typo3fluid-fluid-for-as_argument: as -- -:aspect:`DataType` - string +.. confval:: as + :name: typo3fluid-fluid-for-as + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The name of the iteration variable + The name of the iteration variable -.. _typo3fluid-fluid-for-key: +.. _typo3fluid-fluid-for-key_argument: key --- -:aspect:`DataType` - string +.. confval:: key + :name: typo3fluid-fluid-for-key + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Variable to assign array key to + Variable to assign array key to -.. _typo3fluid-fluid-for-reverse: +.. _typo3fluid-fluid-for-reverse_argument: reverse ------- -:aspect:`DataType` - boolean +.. confval:: reverse + :name: typo3fluid-fluid-for-reverse + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, iterates in reverse + If TRUE, iterates in reverse -.. _typo3fluid-fluid-for-iteration: +.. _typo3fluid-fluid-for-iteration_argument: iteration --------- -:aspect:`DataType` - string +.. confval:: iteration + :name: typo3fluid-fluid-for-iteration + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - The name of the variable to store iteration information (index, cycle, isFirst, isLast, isEven, isOdd) + The name of the variable to store iteration information (index, cycle, isFirst, isLast, isEven, isOdd) diff --git a/Documentation/typo3fluid/fluid/latest/Format/Cdata.rst b/Documentation/typo3fluid/fluid/latest/Format/Cdata.rst index d929fe4..7d17315 100644 --- a/Documentation/typo3fluid/fluid/latest/Format/Cdata.rst +++ b/Documentation/typo3fluid/fluid/latest/Format/Cdata.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/Format/CdataViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/Format/CdataViewHelper.php :navigation-title: format.cdata .. include:: /Includes.rst.txt .. _typo3fluid-fluid-format-cdata: ========================================== -format.cdata ViewHelper `` +Format.cdata ViewHelper `` ========================================== - Outputs an argument/value without any escaping and wraps it with CDATA tags. PAY SPECIAL ATTENTION TO SECURITY HERE (especially Cross Site Scripting), @@ -49,22 +52,32 @@ Output:: +.. _typo3fluid-fluid-format-cdata_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `CdataViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-format-cdata_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-format-cdata-value: +.. _typo3fluid-fluid-format-cdata-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3fluid-fluid-format-cdata-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The value to output + The value to output diff --git a/Documentation/typo3fluid/fluid/latest/Format/Htmlspecialchars.rst b/Documentation/typo3fluid/fluid/latest/Format/Htmlspecialchars.rst index d32075a..5ebd8d3 100644 --- a/Documentation/typo3fluid/fluid/latest/Format/Htmlspecialchars.rst +++ b/Documentation/typo3fluid/fluid/latest/Format/Htmlspecialchars.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/Format/HtmlspecialcharsViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/Format/HtmlspecialcharsViewHelper.php :navigation-title: format.htmlspecialchars .. include:: /Includes.rst.txt .. _typo3fluid-fluid-format-htmlspecialchars: ================================================================ -format.htmlspecialchars ViewHelper `` +Format.htmlspecialchars ViewHelper `` ================================================================ - Applies PHP ``htmlspecialchars()`` escaping to a value. See http://www.php.net/manual/function.htmlspecialchars.php @@ -37,67 +40,70 @@ Output:: Text with & " ' < > * replaced by HTML entities (htmlspecialchars applied). +.. _typo3fluid-fluid-format-htmlspecialchars_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `HtmlspecialcharsViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-format-htmlspecialchars_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3fluid-fluid-format-htmlspecialchars-value: +.. contents:: + :local: + + +.. _typo3fluid-fluid-format-htmlspecialchars-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3fluid-fluid-format-htmlspecialchars-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to format + Value to format -.. _typo3fluid-fluid-format-htmlspecialchars-keepquotes: +.. _typo3fluid-fluid-format-htmlspecialchars-keepquotes_argument: keepQuotes ---------- -:aspect:`DataType` - boolean +.. confval:: keepQuotes + :name: typo3fluid-fluid-format-htmlspecialchars-keepquotes + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE quotes will not be replaced (ENT_NOQUOTES) + If TRUE quotes will not be replaced (ENT_NOQUOTES) -.. _typo3fluid-fluid-format-htmlspecialchars-encoding: +.. _typo3fluid-fluid-format-htmlspecialchars-encoding_argument: encoding -------- -:aspect:`DataType` - string +.. confval:: encoding + :name: typo3fluid-fluid-format-htmlspecialchars-encoding + :type: string + :Default: 'UTF-8' + :required: false -:aspect:`Default` - 'UTF-8' + Encoding -:aspect:`Required` - false -:aspect:`Description` - Encoding - -.. _typo3fluid-fluid-format-htmlspecialchars-doubleencode: +.. _typo3fluid-fluid-format-htmlspecialchars-doubleencode_argument: doubleEncode ------------ -:aspect:`DataType` - boolean - -:aspect:`Default` - true +.. confval:: doubleEncode + :name: typo3fluid-fluid-format-htmlspecialchars-doubleencode + :type: boolean + :Default: true + :required: false -:aspect:`Required` - false -:aspect:`Description` - If FALSE html entities will not be encoded + If FALSE html entities will not be encoded diff --git a/Documentation/typo3fluid/fluid/latest/Format/Printf.rst b/Documentation/typo3fluid/fluid/latest/Format/Printf.rst index 422dee4..640b8d0 100644 --- a/Documentation/typo3fluid/fluid/latest/Format/Printf.rst +++ b/Documentation/typo3fluid/fluid/latest/Format/Printf.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/Format/PrintfViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/Format/PrintfViewHelper.php :navigation-title: format.printf .. include:: /Includes.rst.txt .. _typo3fluid-fluid-format-printf: ============================================ -format.printf ViewHelper `` +Format.printf ViewHelper `` ============================================ - A ViewHelper for formatting values with printf. Either supply an array for the arguments or a single value. @@ -62,38 +65,45 @@ Output:: We love TYPO3 +.. _typo3fluid-fluid-format-printf_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `PrintfViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-format-printf_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3fluid-fluid-format-printf-value: +.. contents:: + :local: + + +.. _typo3fluid-fluid-format-printf-value_argument: value ----- -:aspect:`DataType` - string +.. confval:: value + :name: typo3fluid-fluid-format-printf-value + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - String to format + String to format -.. _typo3fluid-fluid-format-printf-arguments: +.. _typo3fluid-fluid-format-printf-arguments_argument: arguments --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: arguments + :name: typo3fluid-fluid-format-printf-arguments + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - The arguments for vsprintf + The arguments for vsprintf diff --git a/Documentation/typo3fluid/fluid/latest/Format/Raw.rst b/Documentation/typo3fluid/fluid/latest/Format/Raw.rst index bba92d0..aa705f7 100644 --- a/Documentation/typo3fluid/fluid/latest/Format/Raw.rst +++ b/Documentation/typo3fluid/fluid/latest/Format/Raw.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/Format/RawViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/Format/RawViewHelper.php :navigation-title: format.raw .. include:: /Includes.rst.txt .. _typo3fluid-fluid-format-raw: ====================================== -format.raw ViewHelper `` +Format.raw ViewHelper `` ====================================== - Outputs an argument/value without any escaping. Is normally used to output an ObjectAccessor which should not be escaped, but output as-is. @@ -50,22 +53,32 @@ Output:: (Content of ``{string}`` without any conversion/escaping) +.. _typo3fluid-fluid-format-raw_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `RawViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-format-raw_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-format-raw-value: +.. _typo3fluid-fluid-format-raw-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3fluid-fluid-format-raw-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - The value to output + The value to output diff --git a/Documentation/typo3fluid/fluid/latest/GroupedFor.rst b/Documentation/typo3fluid/fluid/latest/GroupedFor.rst index d534168..10c4baa 100644 --- a/Documentation/typo3fluid/fluid/latest/GroupedFor.rst +++ b/Documentation/typo3fluid/fluid/latest/GroupedFor.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/GroupedForViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/GroupedForViewHelper.php :navigation-title: groupedFor .. include:: /Includes.rst.txt .. _typo3fluid-fluid-groupedfor: ====================================== -groupedFor ViewHelper `` +GroupedFor ViewHelper `` ====================================== - Grouped loop ViewHelper. Loops through the specified values. @@ -78,64 +81,69 @@ Output:: +.. _typo3fluid-fluid-groupedfor_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `GroupedForViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-groupedfor_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3fluid-fluid-groupedfor-each: +.. contents:: + :local: + + +.. _typo3fluid-fluid-groupedfor-each_argument: each ---- -:aspect:`DataType` - mixed +.. confval:: each + :name: typo3fluid-fluid-groupedfor-each + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - The array or \SplObjectStorage to iterated over + The array or \SplObjectStorage to iterated over -.. _typo3fluid-fluid-groupedfor-as: +.. _typo3fluid-fluid-groupedfor-as_argument: as -- -:aspect:`DataType` - string +.. confval:: as + :name: typo3fluid-fluid-groupedfor-as + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - The name of the iteration variable + The name of the iteration variable -.. _typo3fluid-fluid-groupedfor-groupby: +.. _typo3fluid-fluid-groupedfor-groupby_argument: groupBy ------- -:aspect:`DataType` - string +.. confval:: groupBy + :name: typo3fluid-fluid-groupedfor-groupby + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Group by this property + Group by this property -.. _typo3fluid-fluid-groupedfor-groupkey: +.. _typo3fluid-fluid-groupedfor-groupkey_argument: groupKey -------- -:aspect:`DataType` - string - -:aspect:`Default` - 'groupKey' +.. confval:: groupKey + :name: typo3fluid-fluid-groupedfor-groupkey + :type: string + :Default: 'groupKey' + :required: false -:aspect:`Required` - false -:aspect:`Description` - The name of the variable to store the current group + The name of the variable to store the current group diff --git a/Documentation/typo3fluid/fluid/latest/If.rst b/Documentation/typo3fluid/fluid/latest/If.rst index a50a9a2..4056430 100644 --- a/Documentation/typo3fluid/fluid/latest/If.rst +++ b/Documentation/typo3fluid/fluid/latest/If.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/IfViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/IfViewHelper.php :navigation-title: if .. include:: /Includes.rst.txt .. _typo3fluid-fluid-if: ====================== -if ViewHelper `` +If ViewHelper `` ====================== - This ViewHelper implements an if/else condition. Conditions: @@ -91,48 +94,56 @@ Output:: The value of the "then" attribute is displayed if the condition evaluates to TRUE. Otherwise, everything the value of the "else"-attribute is displayed. +.. _typo3fluid-fluid-if_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `IfViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-if_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-if-then: +.. _typo3fluid-fluid-if-then_argument: then ---- -:aspect:`DataType` - mixed +.. confval:: then + :name: typo3fluid-fluid-if-then + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if met. + Value to be returned if the condition if met. -.. _typo3fluid-fluid-if-else: +.. _typo3fluid-fluid-if-else_argument: else ---- -:aspect:`DataType` - mixed +.. confval:: else + :name: typo3fluid-fluid-if-else + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to be returned if the condition if not met. + Value to be returned if the condition if not met. -.. _typo3fluid-fluid-if-condition: +.. _typo3fluid-fluid-if-condition_argument: condition --------- -:aspect:`DataType` - boolean +.. confval:: condition + :name: typo3fluid-fluid-if-condition + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - Condition expression conforming to Fluid boolean rules + Condition expression conforming to Fluid boolean rules diff --git a/Documentation/typo3fluid/fluid/latest/Inline.rst b/Documentation/typo3fluid/fluid/latest/Inline.rst index 607d148..7944b03 100644 --- a/Documentation/typo3fluid/fluid/latest/Inline.rst +++ b/Documentation/typo3fluid/fluid/latest/Inline.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/InlineViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/InlineViewHelper.php :navigation-title: inline .. include:: /Includes.rst.txt .. _typo3fluid-fluid-inline: ============================== -inline ViewHelper `` +Inline ViewHelper `` ============================== - Inline Fluid rendering ViewHelper Renders Fluid code stored in a variable, which you normally would @@ -28,22 +31,32 @@ Which outputs:: You can use this to pass smaller and dynamic pieces of Fluid code to templates, as an alternative to creating new partial templates. +.. _typo3fluid-fluid-inline_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `InlineViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-inline_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-inline-code: +.. _typo3fluid-fluid-inline-code_argument: code ---- -:aspect:`DataType` - string +.. confval:: code + :name: typo3fluid-fluid-inline-code + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Fluid code to be rendered as if it were part of the template rendering it. Can be passed as inline argument or tag content + Fluid code to be rendered as if it were part of the template rendering it. Can be passed as inline argument or tag content diff --git a/Documentation/typo3fluid/fluid/latest/Layout.rst b/Documentation/typo3fluid/fluid/latest/Layout.rst index fe7bf83..cf945c7 100644 --- a/Documentation/typo3fluid/fluid/latest/Layout.rst +++ b/Documentation/typo3fluid/fluid/latest/Layout.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/LayoutViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/LayoutViewHelper.php :navigation-title: layout .. include:: /Includes.rst.txt .. _typo3fluid-fluid-layout: ============================== -layout ViewHelper `` +Layout ViewHelper `` ============================== - With this tag, you can select a layout to be used for the current template. Examples @@ -21,22 +24,32 @@ Output:: (no output) +.. _typo3fluid-fluid-layout_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `LayoutViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-layout_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-layout-name: +.. _typo3fluid-fluid-layout-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3fluid-fluid-layout-name + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Name of layout to use. If none given, "Default" is used. + Name of layout to use. If none given, "Default" is used. diff --git a/Documentation/typo3fluid/fluid/latest/Or.rst b/Documentation/typo3fluid/fluid/latest/Or.rst index dd136ba..7cb36df 100644 --- a/Documentation/typo3fluid/fluid/latest/Or.rst +++ b/Documentation/typo3fluid/fluid/latest/Or.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/OrViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/OrViewHelper.php :navigation-title: or .. include:: /Includes.rst.txt .. _typo3fluid-fluid-or: ====================== -or ViewHelper `` +Or ViewHelper `` ====================== - Or ViewHelper If content is null use alternative text. @@ -30,48 +33,56 @@ it might be more handy to use a ternary operator instead of f:or {emptyVariable ?: 'this is an alterative text'} +.. _typo3fluid-fluid-or_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `OrViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-or_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-or-content: +.. _typo3fluid-fluid-or-content_argument: content ------- -:aspect:`DataType` - mixed +.. confval:: content + :name: typo3fluid-fluid-or-content + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Content to check if null + Content to check if null -.. _typo3fluid-fluid-or-alternative: +.. _typo3fluid-fluid-or-alternative_argument: alternative ----------- -:aspect:`DataType` - mixed +.. confval:: alternative + :name: typo3fluid-fluid-or-alternative + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Alternative if content is null + Alternative if content is null -.. _typo3fluid-fluid-or-arguments: +.. _typo3fluid-fluid-or-arguments_argument: arguments --------- -:aspect:`DataType` - mixed +.. confval:: arguments + :name: typo3fluid-fluid-or-arguments + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Arguments to be replaced in the resulting string, using sprintf + Arguments to be replaced in the resulting string, using sprintf diff --git a/Documentation/typo3fluid/fluid/latest/Render.rst b/Documentation/typo3fluid/fluid/latest/Render.rst index e2edee8..fea9a09 100644 --- a/Documentation/typo3fluid/fluid/latest/Render.rst +++ b/Documentation/typo3fluid/fluid/latest/Render.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/RenderViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/RenderViewHelper.php :navigation-title: render .. include:: /Includes.rst.txt .. _typo3fluid-fluid-render: ============================== -render ViewHelper `` +Render ViewHelper `` ============================== - A ViewHelper to render a section, a partial, a specified section in a partial or a delegate ParsedTemplateInterface implementation. @@ -97,103 +100,105 @@ recursive rendering, contentAs argument, default value etc. Note that while ParsedTemplateInterface supports returning a Layout name, this Layout will not be respected when rendering using this method. Only the ``render()`` method will be called! +.. _typo3fluid-fluid-render_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `RenderViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-render_arguments: Arguments ========= +The following arguments are available for ``: -.. _typo3fluid-fluid-render-section: +.. contents:: + :local: + + +.. _typo3fluid-fluid-render-section_argument: section ------- -:aspect:`DataType` - string +.. confval:: section + :name: typo3fluid-fluid-render-section + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Section to render - combine with partial to render section in partial + Section to render - combine with partial to render section in partial -.. _typo3fluid-fluid-render-partial: +.. _typo3fluid-fluid-render-partial_argument: partial ------- -:aspect:`DataType` - string +.. confval:: partial + :name: typo3fluid-fluid-render-partial + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Partial to render, with or without section + Partial to render, with or without section -.. _typo3fluid-fluid-render-delegate: +.. _typo3fluid-fluid-render-delegate_argument: delegate -------- -:aspect:`DataType` - string +.. confval:: delegate + :name: typo3fluid-fluid-render-delegate + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - Optional PHP class name of a permanent, included-in-app ParsedTemplateInterface implementation to override partial/section + Optional PHP class name of a permanent, included-in-app ParsedTemplateInterface implementation to override partial/section -.. _typo3fluid-fluid-render-arguments: +.. _typo3fluid-fluid-render-arguments_argument: arguments --------- -:aspect:`DataType` - mixed - -:aspect:`Default` - array () +.. confval:: arguments + :name: typo3fluid-fluid-render-arguments + :type: mixed + :Default: array () + :required: false -:aspect:`Required` - false -:aspect:`Description` - Array of variables to be transferred. Use {_all} for all variables + Array of variables to be transferred. Use {_all} for all variables -.. _typo3fluid-fluid-render-optional: +.. _typo3fluid-fluid-render-optional_argument: optional -------- -:aspect:`DataType` - boolean +.. confval:: optional + :name: typo3fluid-fluid-render-optional + :type: boolean + :required: false -:aspect:`Required` - false -:aspect:`Description` - If TRUE, considers the *section* optional. Partial never is. + If TRUE, considers the *section* optional. Partial never is. -.. _typo3fluid-fluid-render-default: +.. _typo3fluid-fluid-render-default_argument: default ------- -:aspect:`DataType` - mixed +.. confval:: default + :name: typo3fluid-fluid-render-default + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value (usually string) to be displayed if the section or partial does not exist + Value (usually string) to be displayed if the section or partial does not exist -.. _typo3fluid-fluid-render-contentas: +.. _typo3fluid-fluid-render-contentas_argument: contentAs --------- -:aspect:`DataType` - string +.. confval:: contentAs + :name: typo3fluid-fluid-render-contentas + :type: string + :required: false -:aspect:`Required` - false -:aspect:`Description` - If used, renders the child content and adds it as a template variable with this name for use in the partial/section + If used, renders the child content and adds it as a template variable with this name for use in the partial/section diff --git a/Documentation/typo3fluid/fluid/latest/Section.rst b/Documentation/typo3fluid/fluid/latest/Section.rst index 7dfa695..66fb16b 100644 --- a/Documentation/typo3fluid/fluid/latest/Section.rst +++ b/Documentation/typo3fluid/fluid/latest/Section.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/SectionViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/SectionViewHelper.php :navigation-title: section .. include:: /Includes.rst.txt .. _typo3fluid-fluid-section: ================================ -section ViewHelper `` +Section ViewHelper `` ================================ - A ViewHelper to declare sections in templates for later use with e.g. the ``f:render`` ViewHelper. Examples @@ -56,22 +59,32 @@ Output:: [...] (depending on the value of {menu}) +.. _typo3fluid-fluid-section_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `SectionViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-section_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-section-name: +.. _typo3fluid-fluid-section-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3fluid-fluid-section-name + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Name of the section + Name of the section diff --git a/Documentation/typo3fluid/fluid/latest/Spaceless.rst b/Documentation/typo3fluid/fluid/latest/Spaceless.rst index 2b1b2a6..06e2b27 100644 --- a/Documentation/typo3fluid/fluid/latest/Spaceless.rst +++ b/Documentation/typo3fluid/fluid/latest/Spaceless.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/SpacelessViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/SpacelessViewHelper.php :navigation-title: spaceless .. include:: /Includes.rst.txt .. _typo3fluid-fluid-spaceless: ==================================== -spaceless ViewHelper `` +Spaceless ViewHelper `` ==================================== - Space Removal ViewHelper Removes redundant spaces between HTML tags while @@ -37,11 +40,11 @@ Output:: text +.. _typo3fluid-fluid-spaceless_source: -.. _typo3fluid-fluid-spaceless_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `SpacelessViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3fluid/fluid/latest/Switch.rst b/Documentation/typo3fluid/fluid/latest/Switch.rst index b418b72..bb26b93 100644 --- a/Documentation/typo3fluid/fluid/latest/Switch.rst +++ b/Documentation/typo3fluid/fluid/latest/Switch.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/SwitchViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/SwitchViewHelper.php :navigation-title: switch .. include:: /Includes.rst.txt .. _typo3fluid-fluid-switch: ============================== -switch ViewHelper `` +Switch ViewHelper `` ============================== - Switch ViewHelper which can be used to render content depending on a value or expression. Implements what a basic PHP ``switch()`` does. @@ -38,22 +41,32 @@ Output:: "Mr.", "Mrs." or "Mr. / Mrs." (depending on the value of {person.gender}) +.. _typo3fluid-fluid-switch_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `SwitchViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-switch_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-switch-expression: +.. _typo3fluid-fluid-switch-expression_argument: expression ---------- -:aspect:`DataType` - mixed +.. confval:: expression + :name: typo3fluid-fluid-switch-expression + :type: mixed + :required: true -:aspect:`Required` - true -:aspect:`Description` - Expression to switch + Expression to switch diff --git a/Documentation/typo3fluid/fluid/latest/Then.rst b/Documentation/typo3fluid/fluid/latest/Then.rst index 35542f0..de0bf61 100644 --- a/Documentation/typo3fluid/fluid/latest/Then.rst +++ b/Documentation/typo3fluid/fluid/latest/Then.rst @@ -1,20 +1,23 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/ThenViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/ThenViewHelper.php :navigation-title: then .. include:: /Includes.rst.txt .. _typo3fluid-fluid-then: ========================== -then ViewHelper `` +Then ViewHelper `` ========================== - ``f:then`` only has an effect inside of ``f:if``. See the ``f:if`` ViewHelper for documentation. +.. _typo3fluid-fluid-then_source: -.. _typo3fluid-fluid-then_arguments: - -Arguments -========= +Source code +=========== +Go to the source code of this ViewHelper: `ThenViewHelper.php (GitHub) `__. -This ViewHelper has no arguments. +.. note:: `` has no arguments. diff --git a/Documentation/typo3fluid/fluid/latest/Variable.rst b/Documentation/typo3fluid/fluid/latest/Variable.rst index f5c4067..1458125 100644 --- a/Documentation/typo3fluid/fluid/latest/Variable.rst +++ b/Documentation/typo3fluid/fluid/latest/Variable.rst @@ -1,13 +1,16 @@ +.. This reStructured text file has been automatically generated, do not change. +.. Source: https://github.com/TYPO3/Fluid/blob/main/src/ViewHelpers/VariableViewHelper.php + +:edit-on-github-link: https://github.com/TYPO3/Fluid/edit/tree/main/src/ViewHelpers/VariableViewHelper.php :navigation-title: variable .. include:: /Includes.rst.txt .. _typo3fluid-fluid-variable: ================================== -variable ViewHelper `` +Variable ViewHelper `` ================================== - Variable assigning ViewHelper Assigns one template variable which will exist also @@ -27,35 +30,44 @@ Usages: {oldvariable -> f:format.htmlspecialchars() -> f:variable(name: 'newvariable')} {oldvariable} +.. _typo3fluid-fluid-variable_source: + +Source code +=========== + +Go to the source code of this ViewHelper: `VariableViewHelper.php (GitHub) `__. .. _typo3fluid-fluid-variable_arguments: Arguments ========= +The following arguments are available for ``: + +.. contents:: + :local: + -.. _typo3fluid-fluid-variable-value: +.. _typo3fluid-fluid-variable-value_argument: value ----- -:aspect:`DataType` - mixed +.. confval:: value + :name: typo3fluid-fluid-variable-value + :type: mixed + :required: false -:aspect:`Required` - false -:aspect:`Description` - Value to assign. If not in arguments then taken from tag content + Value to assign. If not in arguments then taken from tag content -.. _typo3fluid-fluid-variable-name: +.. _typo3fluid-fluid-variable-name_argument: name ---- -:aspect:`DataType` - string +.. confval:: name + :name: typo3fluid-fluid-variable-name + :type: string + :required: true -:aspect:`Required` - true -:aspect:`Description` - Name of variable to create + Name of variable to create