.. include:: /Includes.rst.txt .. index:: TCEFORM Records; editing options .. _tceform: .. _pagetceformconfobj: .. _pagetceformflexformsheet: ======= TCEFORM ======= Allows configuration of how edit forms are rendered in page tree branches in the backend. Can also configure individual tables (for example, from extensions). You can enable and disable options, blind options in selector boxes, etc. See the core API document section :ref:`FormEngine ` for more details on how records are rendered in the backend. .. _tceform-apply-properties: Applying properties =================== The properties listed below apply in various contexts which are explained in each property. A full property path depends on the property and where it is applied. In general, a more specific property path overrides a less specific one: Some properties apply to single fields and are usually set by table or by table and record type. Property paths such as `TCEFORM.[tableName].[fieldName].[propertyName]` configure fields for all types and `TCEFORM.[tableName].[fieldName].types.[typeName].[propertyName]` configure fields for specific types, see the :ref:`TCA type section ` for details on types. Setting property paths should become clearer after you have read through the properties below and looked at the examples. .. youtube:: B3IQq7pIJ_o .. _tceformApplyPropertiesFlexForm: Applying properties to FlexForm fields -------------------------------------- .. deprecated:: 14.0 Using a comma-separated value for `[dataStructureKey]` is deprecated and will stop working in TYPO3 v15. Other properties also apply to :ref:`FlexForm ` fields, in this case the full property path including the data structure key has to be set: .. code-block:: typoscript # TCEFORM.[tableName].[fieldName].[dataStructureKey].[flexSheet].[flexFieldName with escaped dots].[propertyName] TCEFORM.tt_content.pi_flexform.sfregister_create.sDEF.settings\.fields\.selected.addItems.ZZZ = ZZZ The sheet name (sDEF) must be given only if the FlexForm has a sheet. The `[dataStructureKey]` is set to the CType for content elements and the type for all other tables that have a type field defined. See `TCA reference: Using FlexForms `_ for details. The flexFieldName is the name of the property in the FlexForm. If it contains dots `.`, these must be escaped with backslash. Some properties apply to whole FlexForm sheets, their property path is `TCEFORM.[tableName].[fieldName].[dataStructureKey].[flexSheet].[propertyName]`. .. _tceform-properties: Properties ========== .. contents:: :depth: 2 :local: .. index:: Records; select items added .. _tceform-addItems: addItems -------- .. confval:: addItems :name: tceform-addItems :type: plain text label or `label reference `_ Change the list of items in :ref:`TCA type=select ` fields. Using this property, items can be added to the list. Note that the added elements might be removed if the selector represents records: If the select box is a relation to another table. In that case only existing records will be preserved. The subkey :typoscript:`icon` will allow to add your own icons to new values. The subkey :typoscript:`group` can be used to insert a new element into an existing select item group by settings the value to the group identifier. The grouping is usually displayed in select fields with groups available. This property is available for various levels: table level, example: `TCEFORM.tt_content.header_layout.addItems` table and record type level, example: `TCEFORM.tt_content.header_layout.types.textpic.addItems` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.addItems` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. warning:: Do not add page types this way (using `TCEFORM.pages.doktype.addItems`), instead the proper PHP API should be used to do this, see :ref:`Core APIs ` for details. .. _tceform-addItems-example: Example: Add header layout option ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_addItems.typoscript :caption: EXT:site_package/Configuration/page.tsconfig Instead of adding files by path, icon identifiers should be used. .. index:: Records; labels changed .. _tceform-altLabels: altLabels --------- .. confval:: altLabels :name: tceform-altLabels :type: plain text label or `label reference `_ This property applies to :ref:`TCA type=select `, :ref:`TCA type=check ` and :ref:`TCA type=radio `. This property allows you to enter alternative labels for the items in the list. For a single checkbox or radio button, use `default`, for multiple checkboxes and radiobuttons, use an integer for their position starting at 0. This property is available for various levels: table level: `TCEFORM.[tableName].[fieldName].altLabels` table and record type level: `TCEFORM.[tableName].[fieldName].types.[typeName].altLabels` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.altLabels` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. _tceform-altLabels-example: Example: Override labels for document types ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_altLabels.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. figure:: /Images/ManualScreenshots/List/PagesDoktypeDifferentLabels.png :alt: The Page types with modified labels The Page types with modified labels .. note:: If the item has an **empty** value, the syntax is slightly different and an additional dot must be provided, like on this example: .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tt_content.space_before_class.altLabels.. = foo Note the *double dot* after `altLabels`. .. _tceform-page_tsconfig_id: PAGE_TSCONFIG_ID ---------------- .. confval:: PAGE_TSCONFIG_ID :name: tceform-PAGE_TSCONFIG_ID :type: integer This option allows to provide a value for dynamic SQL-WHERE parameters. The value is defined for a specific field of a table. For usage with flexform fields, the entire path to a sub-field must be provided. .. note:: This value can be used for the TCA property :ref:`foreign_table_where ` and for the `addWhere` part of the :ref:`suggest wizard `. .. _tceform-page_tsconfig_id-example: Example: Substitute a marker in a plugin FlexForm ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_ID = 22 In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tx_myextension_table.myfield.PAGE_TSCONFIG_ID = 22 This example might be used for a record in an extension. It refers to a table called `tx_myextension_table` and the field `myfield`. Here the marker will be substituted by the value `22`. .. _tceform-page_tsconfig_idlist: PAGE_TSCONFIG_IDLIST -------------------- .. confval:: PAGE_TSCONFIG_IDLIST :name: tceform-PAGE_TSCONFIG_IDLIST :type: list of integers See above. .. _tceform-page_tsconfig_idlist-example: Example: Substitute a list of IDs in a plugin FlexForm ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_IDLIST = 20,21,22 In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tx_myextension_table.myfield.PAGE_TSCONFIG_IDLIST = 20,21,22 This example might be used for a record in an extension. It refers to a table called `tx_myextension_table` and the field `myfield`. Here the marker will be substituted by the list of integers. .. _tceform-page_tsconfig_str: PAGE_TSCONFIG_STR ----------------- .. confval:: PAGE_TSCONFIG_STR :name: tceform-PAGE_TSCONFIG_STR :type: string See above. .. _tceform-page_tsconfig_str-example: Example: Substitute a string in a plugin FlexForm ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_STR = %hello% In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tx_myextension_table.myfield.PAGE_TSCONFIG_STR = %hello% This example might be used for a record in an extension. It refers to a table called `tx_myextension_table` and the field `myfield`. Here the marker will be substituted by the given value. .. index:: Records; field configuration .. _pageTsConfigTceFormColorPalette: colorPalette ------------ .. confval:: colorPalette :name: tceform-colorPalette :type: string Assign a :ref:`color palette ` to a specific field of a table, for all fields within a table or a global configuration affecting all color pickers within :ref:`FormEngine `. If no palette is defined, FormEngine falls back to all configured colors. .. _pageTsConfigTceFormColorPalette-example: Example: Assign a palette to a field ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_pageTsConfigTceFormColorPalette.typoscript :caption: EXT:my_sitepackage/Configuration/page.tsconfig .. index:: Records; field configuration .. _pageTsConfigTceFormConfig: config ------ .. confval:: config :name: tceform-config This setting allows to override TCA field configuration. This will influence configuration settings in :php:`$GLOBALS['TCA'][]['columns'][]['config'][]`, see :ref:`TCA reference ` for details. Not all configuration options can be overridden, the properties are restricted and depend on the :ref:`field type `. The array `typo3/sysext/backend/Classes/Form/Utility/FormEngineUtility.php->$allowOverrideMatrix` within :ref:`FormEngine code ` defines details: .. code-block:: php :caption: typo3/sysext/backend/Classes/Form/Utility/FormEngineUtility.php 'input' => ['size', 'max', 'readOnly'], 'number' => ['size', 'readOnly'], 'email' => ['size', 'readOnly'], 'link' => ['size', 'readOnly'], 'password' => ['size', 'readOnly'], 'datetime' => ['size', 'readOnly'], 'color' => ['size', 'readOnly'], 'uuid' => ['size', 'enableCopyToClipboard'], 'text' => ['cols', 'rows', 'wrap', 'max', 'readOnly'], 'json' => ['cols', 'rows', 'readOnly'], 'check' => ['cols', 'readOnly'], 'select' => ['size', 'autoSizeMax', 'maxitems', 'minitems', 'readOnly', 'treeConfig', 'fileFolderConfig'], 'category' => ['size', 'maxitems', 'minitems', 'readOnly', 'treeConfig'], 'group' => ['size', 'autoSizeMax', 'maxitems', 'minitems', 'readOnly', 'elementBrowserEntryPoints'], 'folder' => ['size', 'autoSizeMax', 'maxitems', 'minitems', 'readOnly', 'elementBrowserEntryPoints'], 'inline' => ['appearance', 'behaviour', 'foreign_label', 'foreign_selector', 'foreign_unique', 'maxitems', 'minitems', 'size', 'autoSizeMax', 'symmetric_label', 'readOnly'], 'file' => ['appearance', 'behaviour', 'maxitems', 'minitems', 'readOnly'], 'imageManipulation' => ['ratios', 'cropVariants'], The reason that not all properties can be changed is that internally, the :ref:`DataHandler ` performs database operations which require finalized :ref:`TCA ` definitions that are accessed without this TSconfig getting interpreted. This mismatch would then lead to inconsistencies. An `input` or `text` TCA field can *not* enable the :ref:`RTE ` via the :typoscript:`config.enableRichtext` option due to similar reasons in respect to the DataHandler. Also, if for example the :typoscript:`max` definition of a field is made larger than the TCA definition of that field, you may need to to change the file :file:`ext_tables.sql` (see :ref:`t3coreapi:ext_tables-sql`) to adjust column definitions, especially when using the :ref:`Auto-generated structure `. The property :typoscript:`config` is available for these levels: table level, example: :typoscript:`TCEFORM.tt_content.header.config.max` table and record type level, example: :typoscript:`TCEFORM.tt_content.header.types.textpic.config.max` Flex form field level, example: No current TYPO3 version allows to override the configuration of Flex form fields, even though this was previously documented here. This may change in future versions. .. todo: Removed, because this is broken in every known TYPO3 version. .. todo: Maybe re-enable this, if it gets fixed in a future release :typoscript:`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myInputField.config.max` Where :typoscript:`sDEF` is the sheet name and :typoscript:`myext_pi1` the name of the plugin. .. index:: Records; tree configuration .. _pageTsConfigTceFormConfigTreeConfig: config.treeConfig ----------------- .. confval:: config.treeConfig :name: tceform-config-treeConfig :type: int The `treeConfig` sub properties of :ref:`TCEFORM.config ` are dedicated to the TCA config type `select` with :ref:`renderType=selectTree `. A couple of :ref:`treeConfig ` properties can be overriden on page TSconfig level, see their detailed description in the :ref:`TCA reference `: .. literalinclude:: _codesnippets/_pageTsConfigTceFormConfigTreeConfig.typoscript :caption: EXT:site_package/Configuration/page.tsconfig This property is available for various levels: table level, example: `TCEFORM.tt_content.myField.config.treeConfig.startingPoints` table and record type level, example: `TCEFORM.tt_content.header.types.config.treeConfig.startingPoints` Flex form field level, example: No current TYPO3 version allows to override the configuration of Flex form fields, even though this was previously documented here. This may change in future versions. .. todo: Removed, because this is broken in every known TYPO3 version. .. todo: Maybe re-enable this, if it gets fixed in a future release `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.config.treeConfig.startingPoints` Where `sDEF` is the sheet name and :typoscript:`myext_pi1` the name of the plugin. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. index:: Records; field description .. _tceform-description: description ----------- .. figure:: /Images/ManualScreenshots/Input1.png :zoom: lightbox :alt: A common input field in the TYPO3 backend .. confval:: description :name: tceform-description :type: string This property sets or overrides the TCA property :ref:`TCA description `, which allows to define a description for a TCA field, next to its label. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tt_content.header.description = override description As already known from other properties, this can also be configured for a specific language. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tt_content.header.description.de = override description for DE The option can be used on a per record type basis, too. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tt_content.header.types.textpic.description = override description for textpic Also referencing language labels is supported. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.tt_content.header.description = LLL:my_extension.messages:override_description .. index:: Records; field disabled .. _tceform-disabled: disabled -------- .. confval:: disabled :name: tceform-disabled :type: boolean If set, the field is not displayed in the backend form of the record. However, the field can still be set by other means. For example if this property is set: :typoscript:`TCEFORM.tt_content.colPos.disabled = 1` the :guilabel:`Column` field will not be displayed in the content elements form. The content element can still be moved to another column which internally also sets the field `colPos`. Fields with the TSconfig property :tsconfig:`TCEFORM...disabled` therefore show the same behaviour as fields of the TCA type :ref:`passthrough `. table level, example: `TCEFORM.tt_content.header.disabled` table and record type level, example: `TCEFORM.tt_content.header.types.textpic.disabled` Flex form sheet level. If set, the entire tab is not rendered, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.disabled` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.disabled` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. _tceform-disabled-example: Example: Disable editing of the page title ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_disabled.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: Records; select items disable "INVALID VALUE" .. _pageFormEngineDisableNoMatchingElement: disableNoMatchingValueElement ----------------------------- .. confval:: disableNoMatchingValueElement :name: tceform-disableNoMatchingValueElement :type: boolean This property applies only to items in :ref:`TCA type=select ` fields. If a selector box value is not available among the options in the box, the default behavior of TYPO3 is to preserve the value and to show a label which warns about this special state: .. figure:: /Images/ManualScreenshots/List/SelectInvalidValue.png :alt: A missing selector box value is indicated by a warning message A missing selector box value is indicated by a warning message If disableNoMatchingValueElement is set, the element "INVALID VALUE" will not be added to the list. This property is available for various levels: table level, example: `TCEFORM.tt_content.header_layout.disableNoMatchingValueElement` table and record type level, example: `TCEFORM.tt_content.header_layout.types.textpic.disableNoMatchingValueElement` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.disableNoMatchingValueElement` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. _pageFormEngineDisableNoMatchingElement-example: Example: Disable "INVALID VALUE ..." label ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_pageFormEngineDisableNoMatchingElement.typoscript :caption: EXT:site_package/Configuration/page.tsconfig Now the selector box will default to the first element in the selector box: .. figure:: /Images/ManualScreenshots/List/SelectNoInvalidValue.png :alt: Instead of show a warning message the system choose the first element in the selector box Instead of show a warning message the system choose the first element in the selector box .. index:: Records; fileFolderConfig .. _fileFolderConfig: fileFolderConfig ---------------- .. confval:: fileFolderConfig :name: tceform-fileFolderConfig :type: array The special :ref:`fileFolder configuration options ` for TCA columns of type :ref:`TCA type=select ` can be used to fill a select field with files (images / icons) from a defined folder. The `fileFolderConfig` TCA configuration can be overridden with page TSconfig, allowing administrators to use different folders or different file extensions, per site. The same sub properties as in the `fileFolderConfig` TCA configuration are available: .. literalinclude:: _codesnippets/_fileFolderConfig.typoscript :caption: EXT:site_package/Configuration/page.tsconfig This property is available for various levels: table level: `TCEFORM.[tableName].[fieldName].fileFolderConfig.folder` table and record type level: `TCEFORM.[tableName].[fieldName].types.[typeName].fileFolderConfig.folder` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.fileFolderConfig.folder` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. index:: Records; select items user function .. _itemsProcFunc: itemsProcFunc ------------- .. confval:: itemsProcFunc :name: tceform-itemsProcFunc :type: custom This property applies only to items in :ref:`TCA type=select ` fields. The properties of this key is passed on to the :ref:`itemsProcFunc ` in the parameter array by the key "TSconfig". This property is available for various levels: table level: `TCEFORM.[tableName].[fieldName].itemsProcFunc` table and record type level: `TCEFORM.[tableName].[fieldName].types.[typeName].itemsProcFunc` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.itemsProcFunc` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. index:: Records; select items remove .. _tceform-keepItems: keepItems --------- .. confval:: keepItems :name: tceform-keepItems :type: list of values Change the list of items in :ref:`TCA type=select ` fields. Using this property, all items except those defined here are removed. This property is available for various levels: table level, example: `TCEFORM.tt_content.header_layout.keepItems` table and record type level, example: `TCEFORM.tt_content.header_layout.types.textpic.keepItems` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.keepItems` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. _tceform-keepItems-example: Example: Show only standard and spacer pages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_keepItems.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: Records; Field label .. _tceform_label: label ----- .. confval:: label :name: tceform-label :type: plain text label or `label reference `_ This allows you to enter alternative labels for any field. The value can be a plain text label or `label reference `_ to a localization file, the system will then look up the selected backend user language and tries to fetch the localized string if available. However, it is also possible to override these by appending the language key and hard setting a value, for example `label.de = Neuer Feldname`. This property is available for various levels: table level, example: `TCEFORM.[tableName].[fieldName].label` table and record type level, example: `TCEFORM.[tableName].[fieldName].types.[typeName].label` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.label` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. _tceform_label-example: Example: Override the label of a field ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_tceformLabel.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: Records; label for no matching value .. _tceform-noMatchingValue_label: noMatchingValue_label --------------------- .. confval:: noMatchingValue_label :name: tceform-noMatchingValue_label :type: plain text label or `label reference `_ This property applies only to items in :ref:`TCA type=select ` fields, it allows defining a different label of the :ref:`noMatchingValue ` element. It is possible to use the placeholder `%s` to insert the value. If the property is set to empty, the label will be blank. This property is available for various levels: table level, example: `TCEFORM.tt_content.header_layout.noMatchingValue_label` table and record type level, example: `TCEFORM.tt_content.header_layout.types.textpic.noMatchingValue_label` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.noMatchingValue_label` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. _tceform-noMatchingValue_label-example: Example: Replace "INVALID VALUE ..." label with another string ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_noMatchingValueLabel.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. figure:: /Images/ManualScreenshots/List/SelectInvalidValueDifferentLabel.png :alt: An invalid selector box value is indicated by a warning message An invalid selector box value is indicated by a warning message .. index:: Records; select items remove .. _tceform-removeItems: removeItems ----------- .. confval:: removeItems :name: tceform-removeItems :type: list of values Change the list of items in :ref:`TCA type=select ` fields. Using this property, single items can be removed, leaving all others. This property is available for various levels: table level, example: `TCEFORM.tt_content.header_layout.removeItems` table and record type level, example: `TCEFORM.tt_content.header_layout.types.textpic.removeItems` Flex form field level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.removeItems` Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. _tceform-removeItems-example: Example: Remove "Recycler" and "Spacer" page types ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_removeItems.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: FlexForm; Sheet description .. _tceform-sheetDescription: sheetDescription ---------------- .. confval:: sheetDescription :name: tceform-sheetDescription :type: plain text label or `label reference `_ Specifies a description for the sheet shown in the FlexForm. This property is only available on flex form sheet level, for example `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetDescription`. Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. index:: FlexForm; Sheet short description .. _tceform-sheetShortDescr: sheetShortDescr --------------- .. confval:: sheetShortDescr :name: tceform-sheetShortDescr :type: plain text label or `label reference `_ Specifies a short description of the sheet used as link title in the tab-menu. This property is only available on flex form sheet level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetShortDescription`. Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. index:: FlexForm; Sheet title .. _tceform-sheetTitle: sheetTitle ---------- .. confval:: sheetTitle :name: tceform-sheetTitle :type: plain text label or `label reference `_ Set the title of the sheet / tab in a FlexForm configuration. This property is only available on flex form sheet level, example: `TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetTitle`. Where `sDEF` is the sheet name. For a description see the section :ref:`tceformApplyPropertiesFlexForm` on this page. .. _tceform-sheetTitle-example: Example: Rename the first tab of the FlexForm plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. literalinclude:: _codesnippets/_sheetTitle.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: Records; Suggest wizard Suggest wizard .. _pagetceformsuggest: suggest ------- Configuration of the suggest wizard that is available and often enabled for :ref:`TCA type=group ` fields. .. figure:: /Images/ManualScreenshots/List/TcaTypeGroupSuggest.png :alt: A configured suggest wizard A configured suggest wizard The properties listed below are available on various levels. A more specific setting overrides a less specific one: Configuration of all suggest wizards in all tables for all target query tables: `TCEFORM.suggest.default` Configuration of all suggest wizards in all tables looking up records from a specific target table: `TCEFORM.suggest.[queryTable]` Configuration of one suggest wizard field in one table for all target query tables: `TCEFORM.[tableName].[fieldName].suggest.default` Configuration of one suggest wizard field in one table for a specific target query table: `TCEFORM.[tableName].[fieldName].suggest.[queryTable]` Configuration of one suggest wizard field in a flex form field of one table for all target query tables: `TCEFORM.[tableName].[fieldName].[dataStructureKey].[sheetName].[flexFieldName].suggest.default` Configuration of one suggest wizard field in a flex form field of one table for a specific target query table: `TCEFORM.[tableName].[fieldName].[dataStructureKey].[sheetName].[flexFieldName].suggest.[queryTable]` .. index:: Suggest wizard; Search fields additional .. _tceform-suggest-additionalSearchFields: suggest.additionalSearchFields ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: suggest.additionalSearchFields :name: tceform-suggest-additionalSearchFields :type: string Comma-separated list of fields the suggest wizard should also search in. By default the wizard looks only in the fields listed in the :ref:`label ` and :ref:`label_alt ` of TCA :ref:`ctrl properties `. .. index:: Suggest wizard; Where statement .. _tceform-suggest-addWhere: suggest.addWhere ~~~~~~~~~~~~~~~~ .. confval:: suggest.addWhere :name: tceform-suggest-addWhere :type: string Additional WHERE clause (with AND at the beginning). Markers possible for replacement: * ###THIS_UID### * ###CURRENT_PID### * :ref:`###PAGE_TSCONFIG_ID### ` * :ref:`###PAGE_TSCONFIG_IDLIST### ` * :ref:`###PAGE_TSCONFIG_STR### ` .. _tceform-suggest-addWhere-example: Example: limit storage_pid to the children of a certain page ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.pages.storage_pid.suggest.default { addWhere = AND pages.pid=###PAGE_TSCONFIG_ID### } .. index:: Suggest wizard; CSS class .. _tceform-suggest-cssClass: suggest.cssClass ~~~~~~~~~~~~~~~~ .. confval:: suggest.cssClass :name: tceform-suggest-cssClass :type: string Add a CSS class to every list item of the result list. .. literalinclude:: _codesnippets/_cssClass.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: Suggest wizard; hide .. _tceform-suggest-hide: suggest.hide ~~~~~~~~~~~~ .. confval:: suggest.hide :name: tceform-suggest-hide :type: boolean Hide the suggest field. Works only for single fields. .. _tceform-suggest-hide-example: Example: Hide the suggest field for the storage_pid ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.pages.storage_pid.suggest.default { hide = 1 } .. index:: Suggest wizard; Characters max .. _tceform-suggest-maxPathTitleLength: suggest.maxPathTitleLength ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: suggest.maxPathTitleLength :name: tceform-suggest-maxPathTitleLength :type: positive integer Maximum number of characters to display when a path element is too long. .. _tceform-suggest-maxPathTitleLength-example: Example: Limit the suggest field to 30 characters ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.suggest.default { maxPathTitleLength = 30 } .. index:: Suggest wizard; Characters min .. _tceform-suggest-minimumCharacters: suggest.minimumCharacters ~~~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: suggest.minimumCharacters :name: tceform-suggest-minimumCharacters :type: positive integer :Default: 2 Minimum number of characters needed to start the search. Works only for single fields. .. _tceform-suggest-minimumCharacters-example: Example: Start the suggest search after 3 characters ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig TCEFORM.pages.storage_pid.suggest.default { minimumCharacters = 3 } .. index:: Suggest wizard; pid levels .. _tceform-suggest-pidDepth: suggest.pidDepth ~~~~~~~~~~~~~~~~ .. confval:: suggest.pidDepth :name: tceform-suggest-pidDepth :type: positive integer Expand pidList by this number of levels. Only has an effect, if pidList has a value. .. _tceform-suggest-pidDepth-example: Example: Set search depth for suggest field ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. literalinclude:: _codesnippets/_pidDepth.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: Suggest wizard; pid list .. _tceform-suggest-pidList: suggest.pidList ~~~~~~~~~~~~~~~ .. confval:: suggest.pidList :name: tceform-suggest-pidList :type: list of values Limit the search to certain pages (and their subpages). When pidList is empty all pages will be included in the search as long as the backend user is allowed to see them. .. _tceform-suggest-pidList-example: Example: Limit suggest search to records on certain pages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. literalinclude:: _codesnippets/_pidList.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: Suggest wizard; receiver php class .. _tceform-suggest-receiverClass: suggest.receiverClass ~~~~~~~~~~~~~~~~~~~~~ .. confval:: suggest.receiverClass :name: tceform-suggest-receiverClass :type: Fully Qualified PHP class name :Default: :php:`\TYPO3\CMS\Backend\Form\Element\SuggestDefaultReceiver` PHP class alternative receiver class - the file that holds the class should be derived from :php:`\TYPO3\CMS\Backend\Form\Element\SuggestDefaultReceiver`. .. index:: Suggest wizard; rendering user function .. _tceform-suggest-renderFunc: suggest.renderFunc ~~~~~~~~~~~~~~~~~~ .. confval:: suggest.renderFunc :name: tceform-suggest-renderFunc :type: string .. important:: .. versionchanged:: 14.0 PHP functions called via TypoScript **must** now use the PHP attribute :php:`#[AsAllowedCallable]` (:php:`TYPO3\CMS\Core\Attribute\AsAllowedCallable`). User function to manipulate the displayed records in the result. .. index:: Suggest wizard; Where statement .. _tceform-suggest-searchCondition: suggest.searchCondition ~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: suggest.searchCondition :name: tceform-suggest-searchCondition :type: string Additional WHERE clause (no AND needed to prepend). .. _tceform-suggest-searchCondition-example: Example: Only search on pages with doktype=1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. literalinclude:: _codesnippets/_searchCondition.typoscript :caption: EXT:site_package/Configuration/page.tsconfig .. index:: Suggest wizard; Search whole phrase .. _tceform-suggest-searchWholePhrase: suggest.searchWholePhrase ~~~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: suggest.searchWholePhrase :name: tceform-suggest-searchWholePhrase :type: boolean :Default: 0 Whether to do a `LIKE=%mystring%` (searchWholePhrase = 1) or a `LIKE=mystring%` (to do a real find as you type). .. _tceform-suggest-searchWholePhrase-example: Example: Search only for whole phrases ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. literalinclude:: _codesnippets/_searchWholePhrase.typoscript :caption: EXT:site_package/Configuration/page.tsconfig