[BUGFIX] Typos and wording issues in master documentation 51/51551/3
authorStephan Großberndt <stephan@grossberndt.de>
Mon, 6 Feb 2017 10:44:10 +0000 (11:44 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Mon, 6 Feb 2017 20:02:15 +0000 (21:02 +0100)
Fixes: #79639
Releases: master
Change-Id: Ib1a963a4110114de4e2db533e610635a3a47cb6b
Reviewed-on: https://review.typo3.org/51551
Tested-by: TYPO3com <no-reply@typo3.com>
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>
13 files changed:
typo3/sysext/core/Documentation/Changelog/master/Breaking-77934-RemoveSelectKeyFromContentElementPreview.rst
typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-InheritanceOfFlashMessageViewHelper.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RefactoringOfFlashMessageRendering.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RefactoringOfFlashMessageRenderingViewHelper.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RemoveFlashMessageGetMessageAsMarkup.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-DroppedFormEngineMethods.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemoveExtJsCodeFromFormEngineResultArray.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemoveMethodsHookAndPropertyInFormEngine.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemovedExtJsCodeFromFormEngineResultArray.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78988-RemoveOptionalFluidTyposcriptTemplate.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-78988-RemovedOptionalFluidTyposcriptTemplate.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Deprecation-79258-DeprecateLocalizationRepositoryMethods.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/master/Deprecation-79258-MethodsInLocalizationRepository.rst [new file with mode: 0644]

index c10c5e5..8b9c8f3 100644 (file)
@@ -1,8 +1,8 @@
 .. include:: ../../Includes.txt
 
-===========================================================
-Breaking: #77934 - RemoveSelectKeyFromContentElementPreview
-===========================================================
+=========================================================================
+Breaking: #77934 - Remove field `select_key` from content element preview
+=========================================================================
 
 See :issue:`77934`
 
@@ -15,18 +15,18 @@ The value of the field `select_key` has been shown in the preview of a content e
 Impact
 ======
 
-The preview of this field is not available anymore
+The preview of this field is not available anymore.
 
 
 Affected Installations
 ======================
 
-Every installation or 3rd party extension which uses the field
+Every installation or third party extension which uses the field.
 
 
 Migration
 =========
 
-No migration available
+No migration available.
 
-.. index:: Backend
\ No newline at end of file
+.. index:: Backend
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-InheritanceOfFlashMessageViewHelper.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-InheritanceOfFlashMessageViewHelper.rst
new file mode 100644 (file)
index 0000000..bc6daf6
--- /dev/null
@@ -0,0 +1,43 @@
+.. include:: ../../Includes.txt
+
+====================================================================================
+Breaking: #78477 - FlashMessageViewHelper no longer inherits from TagBasedViewHelper
+====================================================================================
+
+See :issue:`78477`
+
+Description
+===========
+
+The :php:`FlashMessageViewHelper` was refactored and no longer inherits from the :php:`TagBasedViewHelper`.
+
+
+Impact
+======
+
+The :php:`FlashMessageViewHelper` outputs default context specific markup. Adding own classes or tag attributes is no longer possible.
+
+
+Affected Installations
+======================
+
+All installations using the :php:`FlashMessageViewHelper` with tag specific attributes.
+
+
+Migration
+=========
+
+Remove the tag specific attributes and style the default output. If you need custom output use the possibility to render FlashMessages yourself, for example:
+
+.. code-block:: html
+
+       <f:flashMessages as="flashMessages">
+           <dl class="messages">
+               <f:for each="{flashMessages}" as="flashMessage">
+                  <dt>CODE!! {flashMessage.code}</dt>
+                  <dd>MESSAGE:: {flashMessage.message}</dd>
+               </f:for>
+           </dl>
+       </f:flashMessages>
+
+.. index:: Backend, Fluid, Frontend
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RefactoringOfFlashMessageRendering.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RefactoringOfFlashMessageRendering.rst
deleted file mode 100644 (file)
index 817fb28..0000000
+++ /dev/null
@@ -1,42 +0,0 @@
-.. include:: ../../Includes.txt
-
-========================================================
-Breaking: #78477 - Refactoring of FlashMessage rendering
-========================================================
-
-See :issue:`78477`
-
-Description
-===========
-
-The FlashMessageViewHelper was refactored and no longer inherits from the TagBasedViewHelper.
-
-Impact
-======
-
-The FlashMessageViewHelper outputs default context specific markup. Adding own classes or tag attributes
-is no longer possible.
-
-Affected Installations
-======================
-
-All installations using the FlashMessageViewHelper with tag specific attributes.
-
-
-Migration
-=========
-
-Remove the tag specific attributes and style the default output. If you need custom output use the possibility to render FlashMessages yourself, for example:
-
-.. code-block:: html
-
-       <f:flashMessages as="flashMessages">
-           <dl class="messages">
-               <f:for each="{flashMessages}" as="flashMessage">
-                  <dt>CODE!! {flashMessage.code}</dt>
-                  <dd>MESSAGE:: {flashMessage.message}</dd>
-               </f:for>
-           </dl>
-       </f:flashMessages>
-
-.. index:: Backend, Fluid, Frontend
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RefactoringOfFlashMessageRenderingViewHelper.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RefactoringOfFlashMessageRenderingViewHelper.rst
deleted file mode 100644 (file)
index ce85648..0000000
+++ /dev/null
@@ -1,37 +0,0 @@
-.. include:: ../../Includes.txt
-
-========================================================
-Breaking: #78477 - Refactoring of FlashMessage rendering
-========================================================
-
-See :issue:`78477`
-
-Description
-===========
-
-The following method has been removed:
-
-* :php:`FlashMessage->getMessageAsMarkup()`
-
-Impact
-======
-
-Using this method will stop working immediately.
-
-
-Affected Installations
-======================
-
-All installations using the mentioned method above.
-
-
-Migration
-=========
-
-Use the new :php:`FlashMessageRendererResolver::class`, for example:
-
-.. code-block:: php
-
-       GeneralUtility::makeInstance(FlashMessageRendererResolver::class)->resolve()->render()
-
-.. index:: Backend, PHP-API
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RemoveFlashMessageGetMessageAsMarkup.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78477-RemoveFlashMessageGetMessageAsMarkup.rst
new file mode 100644 (file)
index 0000000..16d3498
--- /dev/null
@@ -0,0 +1,35 @@
+.. include:: ../../Includes.txt
+
+===================================================================
+Breaking: #78477 - Remove method FlashMessage->getMessageAsMarkup()
+===================================================================
+
+See :issue:`78477`
+
+Description
+===========
+
+The method :php:`FlashMessage->getMessageAsMarkup()` has been removed.
+
+Impact
+======
+
+Using this method will stop working immediately.
+
+
+Affected Installations
+======================
+
+All installations using the mentioned method above.
+
+
+Migration
+=========
+
+Use the new :php:`FlashMessageRendererResolver::class`, for example:
+
+.. code-block:: php
+
+       GeneralUtility::makeInstance(FlashMessageRendererResolver::class)->resolve()->render()
+
+.. index:: Backend, PHP-API
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-DroppedFormEngineMethods.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-DroppedFormEngineMethods.rst
deleted file mode 100644 (file)
index ad0dbd8..0000000
+++ /dev/null
@@ -1,52 +0,0 @@
-.. include:: ../../Includes.txt
-
-=============================================
-Breaking: #78899 - Dropped FormEngine Methods
-=============================================
-
-See :issue:`78899`
-
-Description
-===========
-
-The following methods have been dropped:
-
-* :code:`TYPO3\CMS\Backend\Form\Element\AbstractFormElement->dbFileIcons()`
-* :code:`TYPO3\CMS\Backend\Form\Element\AbstractFormElement->getClipboardElements()`
-* :code:`TYPO3\CMS\Backend\Form\Container\SingleFieldContainer->getMergeBehaviourIcon()`
-* :code:`TYPO3\CMS\Backend\Form\Container\SingleFieldContainer->renderDefaultLanguageDiff()`
-* :code:`TYPO3\CMS\Backend\Form\Container\SingleFieldContainer->renderDefaultLanguageContent()`
-* :code:`TYPO3\CMS\Backend\Form\Container\AbstractContainer->previewFieldValue()`
-
-The following properties have been dropped:
-
-* :code:`TYPO3\CMS\Backend\Form\Element\AbstractFormElement->clipboard`
-
-The following hook interface has been dropped and registered hooks in :code:`dbFileIcons` are no longer called:
-
-* :code:`TYPO3\CMS\Backend\Form\DatabaseFileIconsHookInterface`
-
-TCA wizards registered as :code:`userFunc` no longer receive the element HTML by reference, so they can no longer change
-given HTML string of a given element.
-
-
-Impact
-======
-
-Using above methods, properties and hooks will result in fatal :code:`PHP` errors or fail silently.
-
-
-Affected Installations
-======================
-
-Check extensions for usages of above methods and especially implementations of the hook interface.
-
-
-Migration
-=========
-
-The methods have been partially moved to the :code:`TcaGroup` data provider and merged to the two
-FormEngine elements :code:`GroupEleement` and :code:`SelectMulitpleSideBySideElement`. Those can be
-changed and extended via the FormEngine internal :code:`NodeFactory` and data provider resolvers.
-
-.. index:: Backend, PHP-API
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemoveExtJsCodeFromFormEngineResultArray.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemoveExtJsCodeFromFormEngineResultArray.rst
new file mode 100644 (file)
index 0000000..5acfe11
--- /dev/null
@@ -0,0 +1,38 @@
+.. include:: ../../Includes.txt
+
+==================================================================
+Breaking: #78899 - Remove `extJSCODE` from FormEngine result array
+==================================================================
+
+See :issue:`78899`
+
+Description
+===========
+
+The key :php:`extJSCODE` in the array returned by FormEngines :php:`Container` and :php:`Element` (initialized
+in :php:`AbstractNode->initializeResultArray()`) has been removed.
+
+
+Impact
+======
+
+JavaScript code added to :php:`extJSCODE` by custom elements will not be evaluated anymore.
+
+
+Affected Installations
+======================
+
+Search extensions for the string :php:`extJSCODE`. This array is used rather seldom, but if there are matches
+in combination with Backend Form classes, they should be adapted.
+
+
+Migration
+=========
+
+For a simple solution, add according JavaScript to the return key :php:`additionalJavaScriptPost` for now.
+Both keys were used nearly identically anyway. Be aware that both keys :php:`additionalJavaScriptPost` and
+:php:`additionalJavaScriptSubmit` are target of a later removal as soon as a better JavaScript side event handling
+for those scenarios is in place. See if the current code injected at this point could be done with
+casual :javascript:`RequireJsModules` instead already.
+
+.. index:: Backend, JavaScript, PHP-API
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemoveMethodsHookAndPropertyInFormEngine.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemoveMethodsHookAndPropertyInFormEngine.rst
new file mode 100644 (file)
index 0000000..c5ab6c0
--- /dev/null
@@ -0,0 +1,52 @@
+.. include:: ../../Includes.txt
+
+==================================================================
+Breaking: #78899 - Remove methods, hook and property in FormEngine
+==================================================================
+
+See :issue:`78899`
+
+Description
+===========
+
+The following methods have been removed:
+
+* :php:`TYPO3\CMS\Backend\Form\Element\AbstractFormElement->dbFileIcons()`
+* :php:`TYPO3\CMS\Backend\Form\Element\AbstractFormElement->getClipboardElements()`
+* :php:`TYPO3\CMS\Backend\Form\Container\SingleFieldContainer->getMergeBehaviourIcon()`
+* :php:`TYPO3\CMS\Backend\Form\Container\SingleFieldContainer->renderDefaultLanguageDiff()`
+* :php:`TYPO3\CMS\Backend\Form\Container\SingleFieldContainer->renderDefaultLanguageContent()`
+* :php:`TYPO3\CMS\Backend\Form\Container\AbstractContainer->previewFieldValue()`
+
+The following property has been removed:
+
+* :php:`TYPO3\CMS\Backend\Form\Element\AbstractFormElement->clipboard`
+
+The following hook interface has been removed and registered hooks in :php:`dbFileIcons` are no longer called:
+
+* :php:`TYPO3\CMS\Backend\Form\DatabaseFileIconsHookInterface`
+
+TCA wizards registered as :php:`userFunc` no longer receive the element HTML by reference, so they can no longer change
+given HTML string of a given element.
+
+
+Impact
+======
+
+Using above methods, properties and hooks will result in fatal PHP errors or fail silently.
+
+
+Affected Installations
+======================
+
+Check extensions for usages of above methods and especially implementations of the hook interface.
+
+
+Migration
+=========
+
+The methods have been partially moved to the :php:`TcaGroup` data provider and merged to the two
+FormEngine elements :php:`GroupEleement` and :php:`SelectMulitpleSideBySideElement`. Those can be
+changed and extended via the FormEngine internal :php:`NodeFactory` and data provider resolvers.
+
+.. index:: Backend, PHP-API
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemovedExtJsCodeFromFormEngineResultArray.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78899-RemovedExtJsCodeFromFormEngineResultArray.rst
deleted file mode 100644 (file)
index c1da298..0000000
+++ /dev/null
@@ -1,38 +0,0 @@
-.. include:: ../../Includes.txt
-
-==================================================================
-Breaking: #78899 - Removed ExtJs code from FormEngine result array
-==================================================================
-
-See :issue:`78899`
-
-Description
-===========
-
-The array key `extJSCODE` of FormEngine `Container` and `Element` return array that is initialized
-in `AbstractNode->initializeResultArray()` has been removed.
-
-
-Impact
-======
-
-Custom elements adding JavaScript to this array key will not be evaluated anymore.
-
-
-Affected Installations
-======================
-
-Search extensions for the string `extJSCODE`. This array is used rather seldom, but if there are matches
-in combination with Backend Form classes, they should be adapted.
-
-
-Migration
-=========
-
-For a simple solution, add according JavaScript to the return key `additionalJavaScriptPost` for now.
-Both keys were used nearly identically anyway. Be aware that both keys `additionalJavaScriptPost` and
-`additionalJavaScriptSubmit` are target of a later removal as soon as a better JavaScript side event handling
-for those scenarios is in place. See if the current code injected at this point could be done with
-casual `RequireJsModules` instead already.
-
-.. index:: Backend, JavaScript, PHP-API
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78988-RemoveOptionalFluidTyposcriptTemplate.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78988-RemoveOptionalFluidTyposcriptTemplate.rst
new file mode 100644 (file)
index 0000000..30a829d
--- /dev/null
@@ -0,0 +1,61 @@
+.. include:: ../../Includes.txt
+
+============================================================
+Breaking: #78988 - Remove optional Fluid TypoScript template
+============================================================
+
+See :issue:`78988`
+
+Description
+===========
+
+The static include file "Fluid: (Optional) default ajax configuration (fluid)" was meant as an
+example/showcase on how to use Fluid Widgets in FE. But the currently used includes are outdated or
+broken. Furthermore the way of including files with :typoscript:`page.headerData` instead of
+:typoscript:`page.includeJSLibs` or :typoscript:`page.includeCSSLibs` is not the preferred way anymore. Also in many
+situations this way of including JavaScript and CSS conflicts with other included JavaScript libs
+and CSS files.
+
+Including the files manually has many benefits:
+
+- more control of what versions of the JavaScript libs are included
+- prevent multiple jquery.js includes
+- more control of adjusting styling without resetting/overriding styles delivered by jquery-ui-theme.css
+
+
+Impact
+======
+
+The jQuery JavaScript and CSS files are not included anymore so the AJAX handling in the front-end
+will not work anymore when the site relies on these files.
+
+
+Affected Installations
+======================
+
+All installations that depend on the jQuery includes added by the static TypoScript template
+"Fluid: (Optional) default ajax configuration (fluid)".
+
+
+Migration
+=========
+
+Include the needed file manually in your TypoScript template.
+
+.. code-block:: typoscript
+
+    page.includeJSLibs {
+        jquery = https://code.jquery.com/jquery-3.1.1.slim.min.js
+        jquery.external = 1
+        jquery.integrity = sha256-/SIrNqv8h6QGKDuNoLGA4iret+kyesCkHGzVUUV0shc=
+        jqueryUi = https://code.jquery.com/ui/1.12.1/jquery-ui.min.js
+        jqueryUi.external = 1
+        jqueryUi.integrity = sha256-VazP97ZCwtekAsvgPBSUwPFKdrwD3unUfSGVYrahUqU=
+    }
+
+    page.includeCSSLibs {
+        jqueryUI = https://code.jquery.com/ui/1.12.1/themes/smoothness/jquery-ui.css
+        jqueryUi.external = 1
+    }
+
+.. index:: Fluid, Frontend, JavaScript
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-78988-RemovedOptionalFluidTyposcriptTemplate.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-78988-RemovedOptionalFluidTyposcriptTemplate.rst
deleted file mode 100644 (file)
index 8e7882e..0000000
+++ /dev/null
@@ -1,61 +0,0 @@
-.. include:: ../../Includes.txt
-
-=============================================================
-Breaking: #78988 - Removed optional fluid typoscript template
-=============================================================
-
-See :issue:`78988`
-
-Description
-===========
-
-Static include file "Fluid: (Optional) default ajax configuration (fluid)" was meant as an
-example/showcase on how to use Fluid Widgets in FE. But the current used includes are outdated or
-broken. Furthermore the way of including files with `page.headerData` instead of
-`page.inlcudeJSLibs` or `page.includeCSSLibs` is not the prefered way anymore. Also in many
-situations this way of including JavaScript and CSS conflicts with other included JavaScript libs
-and CSS files.
-
-Including the files manually has many benefits:
-
-- more control of what versions of the javascript libs are included
-- no double jquery.js includes
-- more control of adjusting styling without resetting/overriding styles deliverd by jquery-ui-theme.css
-
-
-Impact
-======
-
-The jQuery JavaScript and CSS files are not included anymore so the AJAX handling in the front-end
-will not work anymore when the site relies on these files.
-
-
-Affected Installations
-======================
-
-All installations that depend on the jQuery includes added by the static typoscript template
-"Fluid: (Optional) default ajax configuration (fluid)".
-
-
-Migration
-=========
-
-Include the needed file manually in your typoscript template.
-
-.. code-block:: typoscript
-
-    page.includeJSLibs {
-        jquery = https://code.jquery.com/jquery-3.1.1.slim.min.js
-        jquery.external = 1
-        jquery.integrity = sha256-/SIrNqv8h6QGKDuNoLGA4iret+kyesCkHGzVUUV0shc=
-        jqueryUi = https://code.jquery.com/ui/1.12.1/jquery-ui.min.js
-        jqueryUi.external = 1
-        jqueryUi.integrity = sha256-VazP97ZCwtekAsvgPBSUwPFKdrwD3unUfSGVYrahUqU=
-    }
-
-    page.includeCSSLibs {
-        jqueryUI = https://code.jquery.com/ui/1.12.1/themes/smoothness/jquery-ui.css
-        jqueryUi.external = 1
-    }
-
-.. index:: Fluid, Frontend, JavaScript
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-79258-DeprecateLocalizationRepositoryMethods.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-79258-DeprecateLocalizationRepositoryMethods.rst
deleted file mode 100644 (file)
index b91ee52..0000000
+++ /dev/null
@@ -1,34 +0,0 @@
-.. include:: ../../Includes.txt
-
-======================================================================================================================
-Deprecation: #79258 - Deprecate LocalizationRepository getRecordLocalization and getPreviousLocalizedRecordUid methods
-======================================================================================================================
-
-See :issue:`79258`
-
-Description
-===========
-
-After the change https://review.typo3.org/#/c/47645/ was merged
-methods :php:`LocalizationRepository::getRecordLocalization()` and :php:`LocalizationRepository::getPreviousLocalizedRecordUid()`
-are not used in the core any more, so they has been marked as deprecated.
-
-
-Impact
-======
-
-Calling these methods will trigger a deprecation log entry. Code using them will work until these methods are removed in TYPO3 v9.
-
-
-Affected Installations
-======================
-
-Any installation using the mentioned methods :php:`LocalizationRepository::getRecordLocalization()` and :php:`LocalizationRepository::getPreviousLocalizedRecordUid()`.
-
-
-Migration
-=========
-
-No migration available.
-
-.. index:: PHP-API
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-79258-MethodsInLocalizationRepository.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-79258-MethodsInLocalizationRepository.rst
new file mode 100644 (file)
index 0000000..8816e76
--- /dev/null
@@ -0,0 +1,33 @@
+.. include:: ../../Includes.txt
+
+===================================================================================================================
+Deprecation: #79258 - Methods getRecordLocalization() and getPreviousLocalizedRecordUid() in LocalizationRepository
+===================================================================================================================
+
+See :issue:`79258`
+
+Description
+===========
+
+The methods :php:`LocalizationRepository::getRecordLocalization()` and :php:`LocalizationRepository::getPreviousLocalizedRecordUid()` have been marked as
+deprecated as they are not used in the core anymore, since https://review.typo3.org/#/c/47645/ was merged.
+
+
+Impact
+======
+
+Calling these methods will trigger a deprecation log entry. Code using them will work until these methods are removed in TYPO3 v9.
+
+
+Affected Installations
+======================
+
+Any installation using the mentioned methods :php:`LocalizationRepository::getRecordLocalization()` and :php:`LocalizationRepository::getPreviousLocalizedRecordUid()`.
+
+
+Migration
+=========
+
+No migration available.
+
+.. index:: PHP-API