[FOLLOWUP] Clean up 7.x documentation 67/38967/2
authorXavier Perseguers <xavier@typo3.org>
Mon, 27 Apr 2015 16:55:58 +0000 (18:55 +0200)
committerXavier Perseguers <xavier@typo3.org>
Mon, 27 Apr 2015 17:36:56 +0000 (19:36 +0200)
There are still a few inconsistencies in the way titles are written.

This patch also corrects some errors which happen upon rendering
to HTML (wrong code blocks).

Change-Id: I09105c94eaed6e8d96d0ae489f95b4e7a19ffd82
Releases: master
Resolves: #66613
Reviewed-on: http://review.typo3.org/38967
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Reviewed-by: Michael Oehlhof <typo3@oehlhof.de>
Reviewed-by: Xavier Perseguers <xavier@typo3.org>
Tested-by: Xavier Perseguers <xavier@typo3.org>
14 files changed:
typo3/sysext/core/Documentation/Changelog/7.1/Breaking-64361-ComposerClassLoading.rst [deleted file]
typo3/sysext/core/Documentation/Changelog/7.1/Deprecation-64361-ComposerClassLoading.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/7.2/Breaking-65727-DontProvideAccessToLocalpathOfFalFiles.rst
typo3/sysext/core/Documentation/Changelog/7.2/Breaking-65922-MoveUnusedTt_contentTcaFieldsToCompatibility6.rst
typo3/sysext/core/Documentation/Changelog/7.2/Breaking-66286-PageTSconfigOptionsToHideWebInfoModulesRenamed.rst
typo3/sysext/core/Documentation/Changelog/7.2/Breaking-66431-NewLoginScreen.rst
typo3/sysext/core/Documentation/Changelog/7.2/Deprecation-64598-DeprecatePagepositionmapjsimgfunc.rst
typo3/sysext/core/Documentation/Changelog/7.2/Deprecation-66065-BackendLogoViewDeprecated.rst
typo3/sysext/core/Documentation/Changelog/7.2/Deprecation-66223-Backendparsetime.rst
typo3/sysext/core/Documentation/Changelog/7.2/Deprecation-66431-NewLoginScreen.rst
typo3/sysext/core/Documentation/Changelog/7.2/Feature-50136-AddSVGSupport.rst
typo3/sysext/core/Documentation/Changelog/7.2/Feature-65585-AddTCATypeImage_manipulation.rst
typo3/sysext/core/Documentation/Changelog/7.2/Feature-66047-IntroduceJavascriptNotificationApi.rst
typo3/sysext/core/Documentation/Changelog/7.2/Feature-66077-IntroduceCalloutsToReplaceContentAlerts.rst

diff --git a/typo3/sysext/core/Documentation/Changelog/7.1/Breaking-64361-ComposerClassLoading.rst b/typo3/sysext/core/Documentation/Changelog/7.1/Breaking-64361-ComposerClassLoading.rst
deleted file mode 100644 (file)
index 0004134..0000000
+++ /dev/null
@@ -1,47 +0,0 @@
-============================================
-Deprecation: #64361 - Composer Class Loading
-============================================
-
-Description
-===========
-
-TYPO3 CMS started integrating composer support and by that embracing PHP standards PSR-0 and PSR-4 for class
-loading that comes with composer.
-The old class loader is still present and registered and will handle loading extension classes
-that do not follow the above mentioned standards.
-
-For the time being a pre-compiled composer class loader is shipped with the git repository,
-so that people using the TYPO3 sources directly from there can use it without requiring a ``composer install``
-step.
-
-It is possible however to do a ``composer install`` in the TYPO3 sources directory or a top level distribution directory
-to gain full control over class loading of your TYPO3 installation. This step is optional and currently requires
-thorough knowledge of composer and as such currently is only recommended for people familiar with this process.
-
-Further technical details can be found in the `wiki`_.
-
-Impact
-======
-
-Third party libraries added to a TYPO3 installation via composer can immediately be used without
-further manual intervention. The classes cache for most core classes will be gone. Resolving classes
-is slowly shifted from a run time task - executed and monitored in every request - to an installation task
-with composer.
-
-Affected installations
-======================
-
-Some installations could be affected which were previously installed via composer,
-but now not properly updated using composer. And outdated Packages/Libraries/autoload.php file
-present in the system will lead to fatal errors.
-
-
-Migration
-=========
-
-If you previously installed TYPO3 via composer, make sure you perform a ``composer update`` command to reflect
-the current changes in your Packages folder.
-
-
-.. _`wiki`: http://wiki.typo3.org/ComposerClassLoader
-
diff --git a/typo3/sysext/core/Documentation/Changelog/7.1/Deprecation-64361-ComposerClassLoading.rst b/typo3/sysext/core/Documentation/Changelog/7.1/Deprecation-64361-ComposerClassLoading.rst
new file mode 100644 (file)
index 0000000..0004134
--- /dev/null
@@ -0,0 +1,47 @@
+============================================
+Deprecation: #64361 - Composer Class Loading
+============================================
+
+Description
+===========
+
+TYPO3 CMS started integrating composer support and by that embracing PHP standards PSR-0 and PSR-4 for class
+loading that comes with composer.
+The old class loader is still present and registered and will handle loading extension classes
+that do not follow the above mentioned standards.
+
+For the time being a pre-compiled composer class loader is shipped with the git repository,
+so that people using the TYPO3 sources directly from there can use it without requiring a ``composer install``
+step.
+
+It is possible however to do a ``composer install`` in the TYPO3 sources directory or a top level distribution directory
+to gain full control over class loading of your TYPO3 installation. This step is optional and currently requires
+thorough knowledge of composer and as such currently is only recommended for people familiar with this process.
+
+Further technical details can be found in the `wiki`_.
+
+Impact
+======
+
+Third party libraries added to a TYPO3 installation via composer can immediately be used without
+further manual intervention. The classes cache for most core classes will be gone. Resolving classes
+is slowly shifted from a run time task - executed and monitored in every request - to an installation task
+with composer.
+
+Affected installations
+======================
+
+Some installations could be affected which were previously installed via composer,
+but now not properly updated using composer. And outdated Packages/Libraries/autoload.php file
+present in the system will lead to fatal errors.
+
+
+Migration
+=========
+
+If you previously installed TYPO3 via composer, make sure you perform a ``composer update`` command to reflect
+the current changes in your Packages folder.
+
+
+.. _`wiki`: http://wiki.typo3.org/ComposerClassLoader
+
index 32b5b5c..eff519a 100644 (file)
@@ -1,5 +1,5 @@
 =================================================================
-Breaking - #65727: Don't provide access to localPath of FAL files
+Breaking: #65727 - Don't provide access to localPath of FAL files
 =================================================================
 
 Description
index 73c8d08..59070f7 100644 (file)
@@ -1,5 +1,5 @@
 ======================================================================
-Breaking - #65922: Move unused tt_content TCA fields to compatibility6
+Breaking: #65922 - Move unused tt_content TCA fields to compatibility6
 ======================================================================
 
 Description
index 3b2a997..6acb805 100644 (file)
@@ -1,5 +1,5 @@
 =========================================================================
-Breaking - #66286: Page TSconfig options to hide Web Info modules renamed
+Breaking: #66286 - Page TSconfig options to hide Web Info modules renamed
 =========================================================================
 
 Description
index 4b6a499..02dba50 100644 (file)
@@ -1,5 +1,5 @@
 ===================================
-Breaking - #66431: New Login Screen
+Breaking: #66431 - New Login Screen
 ===================================
 
 Description
index 18f4655..25319dc 100644 (file)
@@ -1,5 +1,5 @@
 ==========================================================
-Deprecation - #64598: Deprecate PagePositionMap::JSimgFunc
+Deprecation: #64598 - Deprecate PagePositionMap::JSimgFunc
 ==========================================================
 
 Description
@@ -7,7 +7,7 @@ Description
 
 The following function has been marked as deprecated:
 
-* \TYPO3\CMS\Backend\Tree\View\PagePositionMap::JSimgFunc
+* ``\TYPO3\CMS\Backend\Tree\View\PagePositionMap::JSimgFunc``
 
 This method was used only in class PagePositionMap. The implemented "onmouseover" / "onmouseout"
 behaviour to switch between two images was dropped entirely for now. If this is needed, it should
index 4d796b1..dff495d 100644 (file)
@@ -1,5 +1,5 @@
 ==================================================
-Deprecation - #66065: Backend Logo View Deprecated
+Deprecation: #66065 - Backend Logo View Deprecated
 ==================================================
 
 Description
index 5506aa8..9f92158 100644 (file)
@@ -1,5 +1,5 @@
 ==================================================
-Deprecation - #66223: Backend parseTime deprecated
+Deprecation: #66223 - Backend parseTime deprecated
 ==================================================
 
 Description
index 67eb1cd..1ceee1f 100644 (file)
@@ -1,5 +1,5 @@
 ======================================
-Deprecation - #66431: New Login Screen
+Deprecation: #66431 - New Login Screen
 ======================================
 
 Description
index d8cca62..412d953 100644 (file)
@@ -1,5 +1,5 @@
 =================================
-Feature - #50136: Add SVG support
+Feature: #50136 - Add SVG support
 =================================
 
 Description
index 620d830..7f0370c 100644 (file)
@@ -1,37 +1,37 @@
 ================================================
-Feature - #65585: Add TCA type imageManipulation
+Feature: #65585 - Add TCA type imageManipulation
 ================================================
 
 Description
 ===========
 
-TCA type `imageManipulation` brings a image manipulation wizard to the core.
+TCA type ``imageManipulation`` brings a image manipulation wizard to the core.
 
 This first version brings image cropping with the possibility to
 set a certain aspect ratio for the cropped area. The
 sys_file_reference.crop property is extended and can now also hold
 a json string to describe the image manipulation.
 
-The `LocalCropScaleMaskHelper` that is used by the core
+The ``LocalCropScaleMaskHelper`` that is used by the core
 to create adjusted images is also adjusted to handle the new format.
 
 
 Impact
 ======
 
-There is an new TCA type column type `imageManipulation` it supports the following config:
+There is an new TCA type column type ``imageManipulation`` it supports the following config:
 
-- file_field: string, default `uid_local`
-- enableZoom: bool, default `FALSE`
-- allowedExtensions: string, default `$GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext']`
+- file_field: string, default ``uid_local``
+- enableZoom: bool, default ``FALSE``
+- allowedExtensions: string, default ``$GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext']``
 - ratios: array, default
-    '1.7777777777777777' => '16:9',
-    '1.3333333333333333' => '4:3',
-    '1' => '1:1',
-    'NaN' => 'Free',
 
-When `ratios` is set in TCA the defaults are neglected.
+  - '1.7777777777777777' => '16:9',
+  - '1.3333333333333333' => '4:3',
+  - '1' => '1:1',
+  - 'NaN' => 'Free',
 
+When ``ratios`` is set in TCA the defaults are neglected.
 
-Property `sys_file_reference.crop` can now hold a string representing a json object. `LocalCropScaleMaskHelper` checks
-if the it can parse the string as json. If it can it assumes it holds the properties: `x`, `y`, `width` and `height`.
\ No newline at end of file
+Property ``sys_file_reference.crop`` can now hold a string representing a json object. ``LocalCropScaleMaskHelper`` checks
+if the it can parse the string as json. If it can it assumes it holds the properties: ``x``, ``y``, ``width`` and ``height``.
\ No newline at end of file
index 3f308dd..f814b5b 100644 (file)
@@ -1,5 +1,5 @@
 =======================================================
-Feature - #66047: Introduce JavaScript notification API
+Feature: #66047 - Introduce JavaScript notification API
 =======================================================
 
 Description
@@ -27,11 +27,11 @@ Examples:
 
 .. code-block:: javascript
 
-    // Old and deprecated:
-    top.TYPO3.Flashmessages.display(TYPO3.Severity.notice)
+       // Old and deprecated:
+       top.TYPO3.Flashmessages.display(TYPO3.Severity.notice)
 
-    // New and the only correct way:
-    top.TYPO3.Notification.notice(title, message)
+       // New and the only correct way:
+       top.TYPO3.Notification.notice(title, message)
 
 
 2) Notice notification
@@ -39,7 +39,7 @@ Examples:
 .. code-block:: javascript
 
        // duration is optional, default is 5 seconds
-    top.TYPO3.Notification.notice(title, message, duration)
+       top.TYPO3.Notification.notice(title, message, duration)
 
 
 3) Info notification
@@ -47,7 +47,7 @@ Examples:
 .. code-block:: javascript
 
        // duration is optional, default is 5 seconds
-    top.TYPO3.Notification.info(title, message, duration)
+       top.TYPO3.Notification.info(title, message, duration)
 
 
 4) Success notification
@@ -55,7 +55,7 @@ Examples:
 .. code-block:: javascript
 
        // duration is optional, default is 5 seconds
-    top.TYPO3.Notification.success(title, message, duration)
+       top.TYPO3.Notification.success(title, message, duration)
 
 
 5) Warning notification
@@ -63,7 +63,7 @@ Examples:
 .. code-block:: javascript
 
        // duration is optional, default is 5 seconds
-    top.TYPO3.Notification.warning(title, message, duration)
+       top.TYPO3.Notification.warning(title, message, duration)
 
 
 6) Error notification
@@ -71,4 +71,4 @@ Examples:
 .. code-block:: javascript
 
        // duration is optional, default is 0 seconds which means sticky!
-    top.TYPO3.Notification.error(title, message, duration)
+       top.TYPO3.Notification.error(title, message, duration)
index 8ee1832..5a8ae4a 100644 (file)
@@ -1,5 +1,5 @@
 ==============================================================
-Feature - #66077: Introduce callouts to replace content alerts
+Feature: #66077 - Introduce callouts to replace content alerts
 ==============================================================
 
 Description
@@ -26,4 +26,6 @@ Simple infobox with a title
 
 All options
 
+.. code-block:: html
+
        <f:be.infobox title="Message title" message="your box content" state="-2" iconName="check" disableIcon="TRUE" />
\ No newline at end of file