[DOCS] 7.5 Docs Part 7/4 02/43502/2
authorMathias Schreiber <mathias.schreiber@wmdb.de>
Wed, 23 Sep 2015 12:37:18 +0000 (14:37 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Wed, 23 Sep 2015 13:23:17 +0000 (15:23 +0200)
Proofread and move various Documentation Vol. 3

Change-Id: I6bb9c93ea76a6147fc6a21ff1fdc7a8fb95b8618
Reviewed-on: http://review.typo3.org/43502
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
12 files changed:
typo3/sysext/core/Documentation/Changelog/7.5/Breaking-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69535-DeprecateTYPO3CMSFluidViewHelpersBeButtonsIconViewHelper.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69754-TcaCtrlIconfileUsingRelativePathToExtAndFilenameOnly.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69938-HIDE_L10N_SIBLINGSFlexFormdisplayCond.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/7.5/Feature-56282-LanguageSelectorForPageviewModule.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Deprecation-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Deprecation-69535-DeprecateTYPO3CMSFluidViewHelpersBeButtonsIconViewHelper.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Deprecation-69754-TcaCtrlIconfileUsingRelativePathToExtAndFilenameOnly.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Deprecation-69938-HIDE_L10N_SIBLINGSFlexFormdisplayCond.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Feature-56282-LanguageSelectorForPageviewModule.rst [deleted file]

diff --git a/typo3/sysext/core/Documentation/Changelog/7.5/Breaking-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst b/typo3/sysext/core/Documentation/Changelog/7.5/Breaking-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst
new file mode 100644 (file)
index 0000000..cb10a0e
--- /dev/null
@@ -0,0 +1,34 @@
+==========================================================================
+Breaking: #69057 - Deprecate IconUtility and move methods into IconFactory
+==========================================================================
+
+Description
+===========
+
+While refactoring the ``IconUtility`` to the new ``IconFactory`` class, several methods have been marked as deprecated.
+In some cases parameters of the old ``IconUtility`` methods are not used anymore.
+The following list describes the possible breaking changes.
+
+The second parameter ``$options`` of method ``IconUtility::getSpriteIconForFile()`` is not used anymore.
+The third parameter ``$options`` of method ``IconUtility::getSpriteIconForRecord()`` is not used anymore.
+
+The ``IconUtility`` signals ``buildSpriteIconClasses`` and ``buildSpriteHtmlIconTag`` have been dropped and will not be emitted anymore.
+The ``IconUtility`` hook ``$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_iconworks.php']['overrideIconOverlay']`` has been dropped and will not be called anymore.
+
+
+Impact
+======
+
+Extensions could break if the methods, signals or hooks above are used.
+
+
+Affected Installations
+======================
+
+Extensions that call the methods with the ``$options`` parameter or make use of the signals and hook.
+
+
+Migration
+=========
+
+Make use of the new ``IconFactory`` class.
diff --git a/typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst b/typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst
new file mode 100644 (file)
index 0000000..119b5e9
--- /dev/null
@@ -0,0 +1,42 @@
+=============================================================================
+Deprecation: #69057 - Deprecate IconUtility and move methods into IconFactory
+=============================================================================
+
+Description
+===========
+
+The ``IconUtility`` class will be removed with TYPO3 CMS 8. All public methods of this class have been marked as deprecated:
+
+* ``IconUtility::skinImg()``
+* ``IconUtility::getIcon()``
+* ``IconUtility::getSpriteIcon()``
+* ``IconUtility::getSpriteIconForFile()``
+* ``IconUtility::getSpriteIconForRecord()``
+* ``IconUtility::getSpriteIconForResource()``
+* ``IconUtility::getSpriteIconClasses()``
+
+The PageTSConfig setting ``mod.wizards.newContentElement.wizardItems.*.elements.*.icon`` also has been marked as deprecated.
+
+The ``IconUtilityOverrideResourceIconHookInterface`` interface will be removed with TYPO3 CMS 8.
+
+
+Impact
+======
+
+Any usage of these methods will trigger a deprecation log entry.
+
+
+Affected Installations
+======================
+
+Extensions that call these PHP methods directly.
+Extensions that register own content elements with an icon for the new content element wizard.
+
+
+Migration
+=========
+
+Use the new ``IconFactory`` class instead of ``IconUtility``.
+
+For content element wizard register your icon in ``IconRegistry::registerIcon()`` and use the new setting:
+``mod.wizards.newContentElement.wizardItems.*.elements.*.iconIdentifier``
diff --git a/typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69535-DeprecateTYPO3CMSFluidViewHelpersBeButtonsIconViewHelper.rst b/typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69535-DeprecateTYPO3CMSFluidViewHelpersBeButtonsIconViewHelper.rst
new file mode 100644 (file)
index 0000000..b721873
--- /dev/null
@@ -0,0 +1,28 @@
+======================================================================================
+Deprecation: #69535 - Deprecate \TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\IconViewHelper
+======================================================================================
+
+Description
+===========
+
+``\TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\IconViewHelper`` has been marked as deprecated.
+
+
+Impact
+======
+
+The viewhelper should not be used any longer and will be removed with TYPO3 CMS 8.
+
+
+Affected Installations
+======================
+
+Extensions which use the viewhelper.
+
+
+Migration
+=========
+
+Use the core icon viewhelper ``\TYPO3\CMS\Core\ViewHelpers\IconViewHelper`` instead.
+
+Example: Instead of ``<f:be.buttons.icon icon="apps-pagetree-collapse" />`` use ``<core:icon identifier="apps-pagetree-collapse" />``
diff --git a/typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69754-TcaCtrlIconfileUsingRelativePathToExtAndFilenameOnly.rst b/typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69754-TcaCtrlIconfileUsingRelativePathToExtAndFilenameOnly.rst
new file mode 100644 (file)
index 0000000..9c9f26e
--- /dev/null
@@ -0,0 +1,75 @@
+=================================================================================================================
+Deprecation: #69754 - Deprecate relative path to extension directory and using filename only in TCA ctrl iconfile
+=================================================================================================================
+
+Description
+===========
+
+* Using relative paths to refer to the extension directory for iconfiles in ``TCA['ctrl']['iconfile']`` has been marked as deprecated.
+* Using filenames only to refer to an iconfile in TCA['ctrl'] has been marked as deprecated.
+
+
+Impact
+======
+
+* TCA definitions in ``TCA['ctrl']['iconfile']`` containing ``'../typo3conf/ext/'`` or calls to ``\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath()`` will trigger a deprecation log entry.
+* TCA definitions in ``TCA['ctrl']['iconfile']`` containing a filename only will trigger a deprecation log entry.
+
+
+Affected Installations
+======================
+
+Any installation with extensions defining ``TCA['ctrl']['iconfile']`` by using ``../typo3conf/ext/`` or only a filename.
+
+
+Migration
+=========
+
+Relative paths
+--------------
+
+Use ``EXT:`` instead of relative path ``'../typo3conf/ext/'`` or ``\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath()``, e.g.
+
+.. code-block:: php
+
+       'ctrl' => array(
+               'iconfile' => \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath('my_extension') . 'Resources/Public/Icons/image.png'
+       ),
+
+has to be migrated to
+
+.. code-block:: php
+
+       'ctrl' => array(
+               'iconfile' => 'EXT:my_extension/Resources/Public/Icons/image.png'
+       ),
+
+Filename only
+-------------
+
+Use a full absolute path or an ``EXT:`` definition instead of a filename only:
+
+.. code-block:: php
+
+       'ctrl' => array(
+               'iconfile' => '_icon_ftp.gif'
+       ),
+
+has to be migrated to
+
+.. code-block:: php
+
+       'ctrl' => array(
+               'iconfile' => 'EXT:t3skin/icons/gfx/i/_icon_ftp.gif'
+       ),
+
+or
+
+.. code-block:: php
+
+       'ctrl' => array(
+               // You can use absolute paths (to your web root folder) to the icons but
+               // it is discouraged to do so as these icons belong to an extension they
+               // should also be stored in this extension
+               'iconfile' => '/fileadmin/icons/_icon_ftp.gif'
+       ),
diff --git a/typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69938-HIDE_L10N_SIBLINGSFlexFormdisplayCond.rst b/typo3/sysext/core/Documentation/Changelog/7.5/Deprecation-69938-HIDE_L10N_SIBLINGSFlexFormdisplayCond.rst
new file mode 100644 (file)
index 0000000..1f534b7
--- /dev/null
@@ -0,0 +1,15 @@
+============================================================
+Deprecation: #69938 - HIDE_L10N_SIBLINGS FlexFormdisplayCond
+============================================================
+
+Description
+===========
+
+The flexform ``HIDE_L10N_SIBLINGS display`` condition has been marked as deprecated and will be removed with CMS 8.
+The condition could only be used with translation mode ``langChildren=1`` to only show the field for the default language.
+
+
+Impact
+======
+
+FlexForms using this condition will show the field separately for each language again.
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/7.5/Feature-56282-LanguageSelectorForPageviewModule.rst b/typo3/sysext/core/Documentation/Changelog/7.5/Feature-56282-LanguageSelectorForPageviewModule.rst
new file mode 100644 (file)
index 0000000..a9d19bf
--- /dev/null
@@ -0,0 +1,8 @@
+=======================================================
+Feature: #56282 - Language selector for pageview module
+=======================================================
+
+Description
+===========
+
+The pageview module now has a dropdown to select a language for the page preview.
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst
deleted file mode 100644 (file)
index 14ed10c..0000000
+++ /dev/null
@@ -1,34 +0,0 @@
-==========================================================================
-Breaking: #69057 - Deprecate IconUtility and move methods into IconFactory
-==========================================================================
-
-Description
-===========
-
-While refactoring the ``IconUtility`` to the new ``IconFactory`` class, several methods have been marked as deprecated.
-In some cases parameters of the old ``IconUtility`` methods are not used anymore.
-The following list describes the possible breaking changes.
-
-The second parameter $options of method ``IconUtility::getSpriteIconForFile()`` is not used anymore.
-The third parameter $options of method ``IconUtility::getSpriteIconForRecord()`` is not used anymore.
-
-The ``IconUtility`` signals ``buildSpriteIconClasses`` and ``buildSpriteHtmlIconTag`` are dropped and will not be emitted anymore.
-The ``IconUtility`` hook ``$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_iconworks.php']['overrideIconOverlay']`` is dropped and will not be called anymore.
-
-
-Impact
-======
-
-Extensions could break if the methods, signals or hooks above are used.
-
-
-Affected Installations
-======================
-
-Extensions that call the methods with the $options parameter or make use of the signals and hook.
-
-
-Migration
-=========
-
-Make use of the new ``IconFactory`` class.
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-69057-DeprecateIconUtilityAndMoveMethodsIntoIconFactory.rst
deleted file mode 100644 (file)
index a32ef08..0000000
+++ /dev/null
@@ -1,42 +0,0 @@
-=============================================================================
-Deprecation: #69057 - Deprecate IconUtility and move methods into IconFactory
-=============================================================================
-
-Description
-===========
-
-The ``IconUtility`` class will be removed with TYPO3 CMS 8. All public methods of this class have been marked as deprecated:
-
-* ``IconUtility::skinImg()``
-* ``IconUtility::getIcon()``
-* ``IconUtility::getSpriteIcon()``
-* ``IconUtility::getSpriteIconForFile()``
-* ``IconUtility::getSpriteIconForRecord()``
-* ``IconUtility::getSpriteIconForResource()``
-* ``IconUtility::getSpriteIconClasses()``
-
-The PageTS-Config: ``mod.wizards.newContentElement.wizardItems.*.elements.*.icon`` also has been marked as deprecated.
-
-The ``IconUtilityOverrideResourceIconHookInterface`` interface will be removed with TYPO3 CMS 8.
-
-
-Impact
-======
-
-Any usage of these methods will trigger a deprecation log entry.
-
-
-Affected Installations
-======================
-
-Extensions that call these PHP methods directly.
-Extensions that register own content elements with an icon for the new content element wizard.
-
-
-Migration
-=========
-
-Use the new ``IconFactory`` class instead of ``IconUtility``.
-
-For content element wizard register your icon in ``IconRegistry::registerIcon()`` and use the new setting:
-``mod.wizards.newContentElement.wizardItems.*.elements.*.iconIdentifier``
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-69535-DeprecateTYPO3CMSFluidViewHelpersBeButtonsIconViewHelper.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-69535-DeprecateTYPO3CMSFluidViewHelpersBeButtonsIconViewHelper.rst
deleted file mode 100644 (file)
index 72afa3e..0000000
+++ /dev/null
@@ -1,29 +0,0 @@
-======================================================================================
-Deprecation: #69535 - Deprecate \TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\IconViewHelper
-======================================================================================
-
-
-Description
-===========
-
-``\TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\IconViewHelper`` has been deprecated.
-
-
-Impact
-======
-
-The viewhelper should not be used any longer and will be removed with TYPO3 CMS 8.
-
-
-Affected Installations
-======================
-
-Extensions which use the viewhelper.
-
-
-Migration
-=========
-
-Use the core icon viewhelper ``\TYPO3\CMS\Core\ViewHelpers\IconViewHelper`` instead.
-
-Example: Instead of ``<f:be.buttons.icon icon="apps-pagetree-collapse" />`` use ``<core:icon identifier="apps-pagetree-collapse" />``
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-69754-TcaCtrlIconfileUsingRelativePathToExtAndFilenameOnly.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-69754-TcaCtrlIconfileUsingRelativePathToExtAndFilenameOnly.rst
deleted file mode 100644 (file)
index e436dab..0000000
+++ /dev/null
@@ -1,72 +0,0 @@
-=================================================================================================================
-Deprecation: #69754 - Deprecate relative path to extension directory and using filename only in TCA ctrl iconfile
-=================================================================================================================
-
-Description
-===========
-
-* Using relative paths to refer to the extension directory for iconfiles in ``TCA['ctrl']['iconfile']`` has been deprecated.
-* Using filenames only to refer to an iconfile in TCA['ctrl'] has been deprecated.
-
-
-Impact
-======
-
-* TCA definitions in ``TCA['ctrl']['iconfile']`` containing ``'../typo3conf/ext/'`` or calls to ``\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath()`` will trigger a message in the deprecation log.
-* TCA definitions in ``TCA['ctrl']['iconfile']`` containing a filename only will trigger a message in the deprecation log.
-
-
-Affected Installations
-======================
-
-Any installation with extensions defining ``TCA['ctrl']['iconfile']`` by using ``../typo3conf/ext/`` or  a filename only.
-
-
-Migration
-=========
-
-Relative paths
---------------
-
-Use ``EXT:`` instead of relative path ``'../typo3conf/ext/'`` or ``\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath()``, e.g.
-
-.. code-block:: php
-
-       'ctrl' => array(
-               'iconfile' => \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath('my_extension') . 'Resources/Public/Icons/image.png'
-       ),
-
-has to be migrated to
-
-.. code-block:: php
-
-       'ctrl' => array(
-               'iconfile' => 'EXT:my_extension/Resources/Public/Icons/image.png'
-       ),
-
-File name only
---------------
-
-Use a full absolute path or an ``EXT:`` definition instead of a filename only:
-
-.. code-block:: php
-
-       'ctrl' => array(
-               'iconfile' => '_icon_ftp.gif'
-       ),
-
-has to be migrated to
-
-.. code-block:: php
-
-       'ctrl' => array(
-               'iconfile' => 'EXT:t3skin/icons/gfx/i/_icon_ftp.gif'
-       ),
-
-or
-
-.. code-block:: php
-
-       'ctrl' => array(
-               'iconfile' => '/fileadmin/icons/_icon_ftp.gif'
-       ),
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-69938-HIDE_L10N_SIBLINGSFlexFormdisplayCond.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-69938-HIDE_L10N_SIBLINGSFlexFormdisplayCond.rst
deleted file mode 100644 (file)
index 1259cdf..0000000
+++ /dev/null
@@ -1,15 +0,0 @@
-============================================================
-Deprecation: #69938 - HIDE_L10N_SIBLINGS FlexFormdisplayCond
-============================================================
-
-Description
-===========
-
-The flexform HIDE_L10N_SIBLINGS display condition has been deprecated and will be removed with CMS 8.
-The condition could only be used with translation mode `langChildren=1` to only show the field for the default language.
-
-
-Impact
-======
-
-FlexForms using this condition will show the field separately for each language again.
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Feature-56282-LanguageSelectorForPageviewModule.rst b/typo3/sysext/core/Documentation/Changelog/master/Feature-56282-LanguageSelectorForPageviewModule.rst
deleted file mode 100644 (file)
index a9d19bf..0000000
+++ /dev/null
@@ -1,8 +0,0 @@
-=======================================================
-Feature: #56282 - Language selector for pageview module
-=======================================================
-
-Description
-===========
-
-The pageview module now has a dropdown to select a language for the page preview.