TSconfig

1.5.5. ->TCEFORM

Allows detailed configuration of how TCEforms are rendered for a page tree branch and for individual tables if you like. You can enable and disable options, blind options in selector boxes etc.

Property:

Data type:

Description:

[tablename].[field]

[tablename].[field].types.[type]

->TCEFORM_confObj

These objects contain additional configuration of the TCEFORM interface.  For the properties available, refer to the table below. This is a description of how you can customize in general and override for specific types.

 

TCEFORM.[tablename].[field] -  configures the field in TCEFORM for all types.

 

TCEFORM.[tablename].[field].types.[type] - configures the field in TCEFORM in case the 'type'-value of the field matches type.

[tablename].[field].config.[key]

string / array

This setting allows to override TCA field configuration and offers a flexible opportunity to reuse tables and TCA definitions but adapt them to individual demands. So this will influence configuration settings in $TCA[<tablename>]['columns'][<field>]['config'][<key>].

 

Depending on the $TCA type of the field, the allowed keys are:

  1. input - size, max

  2. text - cols, rows, wrap

  3. check - cols, showIfRTE

  4. select - size, autoSizeMax, maxitems, minitems

  5. group - size, autoSizeMax, max_size, show_thumbs, maxitems, minitems, disable_controls

  6. inline - appearance, foreign_label, foreign_selector, foreign_unique, maxitems, minitems, size, autoSizeMax, symmetric_label

suggest.default

suggest.[queryTable]

 

[tablename].[field].suggest.default

[tablename].[field].suggest.[queryTable]

->TCEFORM_suggest

Configuration for the "suggest" wizard. Each level of the configuration overwrites the values of the level below it:

 

  1. "suggest.default" is overwritten by "suggest.[queryTable]".

  2. Both are overwriten by "[tablename].[field].suggest.default" which itself is overwritten by "[tablename].[field].suggest.[queryTable]"

 

suggest.default:

Configuration for all suggest wizards in all tables

 

suggest.[queryTable]:

Configuration for all suggest wizards from all tables listing records from table [queryTable]

 

[tablename].[field].suggest.default

Configuration for the suggest wizard for field [field] in table [tablename]

 

[tablename].[field].suggest.[queryTable]

Configuration for the suggest wizard for field [field] in table [tablename] listing records from [queryTable]

[page:TCEFORM]

->TCEFORM_confObj

Properties for the TCEFORM configuration object (see introduction above).

Property:

Data type:

Description:

disabled

boolean

If set, the field is not rendered.

 

Example:

 

TCEFORM.pages.title {

    # You cannot edit the Page title field now:

  disabled = 1

}

label

string (localized)

This allows you to enter alternative labels for any field.

 

Example:

 

TCEFORM.pages.title {

  label = LLL:EXT:my_ext/locallang_db.xml:table.column

  label.default = New Label

  label.de = Neuer Feldname

}

keepItems

list of values

(applies to select-types only)

 

This keeps in the list only the items defined here. All others are removed.

 

Example:

 

TCEFORM.pages.doktype {

    # Show only standard and "Spacer" page types

  keepItems = 1,199

}

removeItems

list of values

(applies to select-types only)

 

This removes the items from the list which has a value found in this comma list of values.

 

Example:

 

TCEFORM.pages.doktype {

    # Remove the "Recycler" and "Spacer" page type options:

  removeItems = 199, 255

}

addItems.[itemValue]

string (localized)

(applies to select-types only)

 

This will add elements to the list. Notice that the added elements might be removed if the selector represents records. In that case only still existing records will be preserved.

 

Example:

 

TCEFORM.pages.doktype {

    # Creates a new page type option:

  addItems.123 = New Page type!

 

    # Creates yet a page type with "locallang" title:

  addItems.124 = LLL:EXT:lang/locallang_tca.php:title

}

 

This example extends the options for Page types with two new items:


Warning: This example shows the principle of adding adhoc-items to a selector box in TYPO3 but you should not add new page types or Content Element types this way!

disableNoMatchingValueElement

boolean

(applies to select-types only)

 

If set, the element "INVALID VALUE" will not be added to the list.

 

Example:

 

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 show a label that warns about this special state:


Setting this option disables that behavior:

 

TCEFORM.pages.doktype {

    # "INVALID VALUE ..." label will never show up:

  disableNoMatchingValueElement = 1

}

 


... and the selector box will default to the first element in the selector box:

noMatchingValue_label

string (localized)

(applies to select-types only)

 

Allows for an alternative label the "noMatchingValue" element.

You can insert the placeholder "%s" to insert the value.

If you supply a blank value the label will be blank.

 

Example:

 

TCEFORM.pages.doktype {

    # Alternative "INVALID VALUE ..." label:

  noMatchingValue_label = VALUE "%s" was not available!

}

 

The result will be:


altLabels.[item_value]

string (localized)

(applies to select-types only)

 

This allows you to enter alternative labels for the items in the list.

 

Example:

 

TCEFORM.pages.doktype {

    # Setting alternative labels:

  altLabels.1 = STANDARD page type

  altLabels.2 = ADVANCED page type

  altLabels.254 = System Folder (for various elements)

    # Sets the default labels for Recycler (via "locallang"):

  altLabels.255 = LLL:EXT:lang/locallang_tca.php:doktype.I.2

}

 

Result will be:


PAGE_TSCONFIG_ID

integer

(applies to select-types with foreign table)

 

When the select-types are used with foreign-table the where-query has four markers (see description of $TCA in the "Inside TYPO3" document.) The value of three of these markers may be set from Page TSconfig.

PAGE_TSCONFIG_IDLIST

comma list of integers

(applies to select-types with foreign table)

 

See above

PAGE_TSCONFIG_STR

string

(applies to select-types with foreign table)

 

See above

itemsProcFunc.[...]

(custom)

(applies to select-types with itemsProcFunc)

 

The properties of this key is passed on to the itemsProcFunc in the parameter array by the key "TSconfig".

RTEfullScreenWidth

int+/%

(applies for RTE text fields only with the RTE wizard configured)

 

The width of the RTE full screen display. If nothing is set, the whole width is used which means "100%". If you set an integer value, that indicates the pixels width.

linkTitleToSelf

boolean

(all fields)

 

If set, then the title of the field in the forms links to alt_doc.php editing ONLY that field.

Works for existing records only - not new records.

 

Example:

 

TCEFORM.pages.title {

    # The label for the "title" field will link itself

  linkTitleToSelf = 1

}

 

The result is that the label for the title field will be a link:


Clicking the link brings you to a form where only this field is shown:


[page:TCEFORM.(tablename).(field)/TCEFORM.(tablename).(field).types.(type)]

->TCEFORM_suggest

Properties for the suggest wizard (see introduction above).

Property:

Data type:

Description:

Default:

pidList

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 be_user is allowed to see them)

 

Example:

 

TCEFORM.suggest.default {

  # sets the pidList for a suggest fields in all tables

  pidList = 1,2,3,45

}

 

pidDepth

int+

Expand pidList by this number of levels. Has only an effect if pidList has a value.

 

Example:

 

TCEFORM.suggest.default {

  pidList = 6,7

  pidDepth = 4

}

 

minimumCharacters

int+

Minimum number of characters needed to start the search. Works only for single fields.

 

Example:

 

TCEFORM.pages.storage_pid.suggest.default {

  minimumCharacters = 3

}

2

maxPathTitleLength

int+

Maximum number of characters to display when a path element is too long.

 

Example:

 

TCEFORM.suggest.default {

  maxPathTitleLength = 30

}

 

searchWholePhrase

boolean

Whether to do a LIKE=%mystring% (searchWholePhrase = 1) or a LIKE=mystring% (to do a real find as you type).

 

Example:

 

TCEFORM.pages.storage_pid.suggest.default {

  # configures the sugesst wizard for the field "storage_pid" in table "pages" to search only for whole phrases

  searchWholePhrase = 1

}

0

searchCondition

string

Additional WHERE clause (no AND needed to prepend).

 

Example:

 

TCEFORM.pages.storage_pid.suggest.default {

  # configures the sugesst wizard for the field "storage_pid" in table "pages" to search only for pages with doktype=1

  searchCondition = doktype=1

}

 

cssClass

string

Add a CSS class to every list item of the result list.

 

Example:

 

TCEFORM.suggest.pages {

  # configures all sugest wizards listing records from table "pages" to add the css-class "pages" to every list item of the result list.

  cssClass = pages

}

 

receiverClass

string

PHP class alternative receiver class - the file that holds the class needs to be included manually before calling the suggest feature, should be derived from "t3lib_tceforms_suggest_defaultreceiver"

t3lib_tceforms_suggest_defaultreceiver

renderFunc

string

User function to manipulate the displayed records in the result.

 

hide

boolean

Hide the suggest field. Works only for single fields.

 

Example:

 

TCEFORM.pages.storage_pid.suggest.default {

  hide = 1

}

 

[page:TCEFORM.suggest.default/TCEFORM.suggest.(queryTable)/TCEFORM.(tablename).(field).suggest.default/TCEFORM.(tablename).(field).(queryTable)]

To top


Valid XHTML 1.0!