[FEATURE] Introduce TCA > ctrl > descriptionColumn 49/40449/3
authorFelix Kopp <felix-source@phorax.com>
Thu, 18 Jun 2015 13:33:44 +0000 (15:33 +0200)
committerXavier Perseguers <xavier@typo3.org>
Tue, 30 Jun 2015 08:20:31 +0000 (10:20 +0200)
Introduce annotation for table column fields "descriptionColumn". Is
added in TCA > ctrl for tables. Optional setting. Defined table column
that holds description / guidance for editors and admins within backend.

Description should only displayed in the backend.

Adds descriptionColumn to records that already hold internal description.
This patch does not add new description table columns.

Resolves: #67603
Related: #67550
Related: #67578
Releases: master
Change-Id: Ib081e5f14b9cbbcabbbad0d45a7a90274cd3dc09
Reviewed-on: http://review.typo3.org/40449
Reviewed-by: Stefan Neufeind <typo3.neufeind@speedpartner.de>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Xavier Perseguers <xavier@typo3.org>
Tested-by: Xavier Perseguers <xavier@typo3.org>
typo3/sysext/core/Configuration/TCA/be_groups.php
typo3/sysext/core/Configuration/TCA/be_users.php
typo3/sysext/core/Configuration/TCA/sys_category.php
typo3/sysext/core/Configuration/TCA/sys_filemounts.php
typo3/sysext/core/Documentation/Changelog/master/Feature-67603-IntroduceTcaDescriptionColumn.rst [new file with mode: 0644]
typo3/sysext/frontend/Configuration/TCA/backend_layout.php
typo3/sysext/frontend/Configuration/TCA/fe_groups.php
typo3/sysext/frontend/Configuration/TCA/sys_template.php
typo3/sysext/indexed_search/Configuration/TCA/index_config.php
typo3/sysext/sys_action/Configuration/TCA/sys_action.php

index f39e2d0..759a45b 100644 (file)
@@ -2,6 +2,7 @@
 return array(
        'ctrl' => array(
                'label' => 'title',
+               'descriptionColumn' => 'description',
                'tstamp' => 'tstamp',
                'crdate' => 'crdate',
                'cruser_id' => 'cruser_id',
index a2fa03c..743d601 100644 (file)
@@ -2,6 +2,7 @@
 return array(
        'ctrl' => array(
                'label' => 'username',
+               'descriptionColumn' => 'description',
                'tstamp' => 'tstamp',
                'title' => 'LLL:EXT:lang/locallang_tca.xlf:be_users',
                'crdate' => 'crdate',
index fdd3762..634ac48 100644 (file)
@@ -2,6 +2,7 @@
 return array(
        'ctrl' => array(
                'title' => 'LLL:EXT:lang/locallang_tca.xlf:sys_category',
+               'descriptionColumn' => 'description',
                'label' => 'title',
                'tstamp' => 'tstamp',
                'crdate' => 'crdate',
index 2408dd2..a9cb807 100644 (file)
@@ -2,6 +2,7 @@
 return array(
        'ctrl' => array(
                'label' => 'title',
+               'descriptionColumn' => 'description',
                'tstamp' => 'tstamp',
                'sortby' => 'sorting',
                'prependAtCopy' => 'LLL:EXT:lang/locallang_general.xlf:LGL.prependAtCopy',
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Feature-67603-IntroduceTcaDescriptionColumn.rst b/typo3/sysext/core/Documentation/Changelog/master/Feature-67603-IntroduceTcaDescriptionColumn.rst
new file mode 100644 (file)
index 0000000..2325ee6
--- /dev/null
@@ -0,0 +1,18 @@
+==========================================================
+Feature: #67603 - Introduce TCA > ctrl > descriptionColumn
+==========================================================
+
+Description
+===========
+
+To annotate database table column fields as internal description for editors and admins a new setting
+for TCA is introduced. Setting is called ``['TCA']['ctrl']['descriptionColumn']`` and holds column name.
+
+This description should only displayed in the backend to guide editors and admins.
+
+Usage of descriptionColumn is added under different issues.
+
+Impact
+======
+
+None, since annotation itself is added only. Does not impact.
index be4dfb1..f0c2522 100644 (file)
@@ -3,6 +3,7 @@ return array(
        'ctrl' => array(
                'title' => 'LLL:EXT:cms/locallang_tca.xlf:backend_layout',
                'label' => 'title',
+               'descriptionColumn' => 'description',
                'tstamp' => 'tstamp',
                'crdate' => 'crdate',
                'cruser_id' => 'cruser_id',
index f54a96a..2bf7350 100644 (file)
@@ -2,6 +2,7 @@
 return array(
        'ctrl' => array(
                'label' => 'title',
+               'descriptionColumn' => 'description',
                'tstamp' => 'tstamp',
                'crdate' => 'crdate',
                'cruser_id' => 'cruser_id',
index 07135d5..964236c 100644 (file)
@@ -2,6 +2,7 @@
 return array(
        'ctrl' => array(
                'label' => 'title',
+               'descriptionColumn' => 'description',
                'tstamp' => 'tstamp',
                'sortby' => 'sorting',
                'prependAtCopy' => 'LLL:EXT:lang/locallang_general.xlf:LGL.prependAtCopy',
index 60a06f8..704c0d7 100644 (file)
@@ -3,6 +3,7 @@ return array(
        'ctrl' => array(
                'title' => 'LLL:EXT:indexed_search/locallang_db.xlf:index_config',
                'label' => 'title',
+               'descriptionColumn' => 'description',
                'tstamp' => 'tstamp',
                'crdate' => 'crdate',
                'cruser_id' => 'cruser_id',
index 7ac071d..8eb294b 100644 (file)
@@ -2,6 +2,7 @@
 return array(
        'ctrl' => array(
                'label' => 'title',
+               'descriptionColumn' => 'description',
                'tstamp' => 'tstamp',
                'default_sortby' => 'ORDER BY title',
                'sortby' => 'sorting',