[BUGFIX] Documentation of changes has invalid reStructuredText 69/40469/3
authorXavier Perseguers <xavier@typo3.org>
Fri, 19 Jun 2015 13:05:00 +0000 (15:05 +0200)
committerXavier Perseguers <xavier@typo3.org>
Mon, 22 Jun 2015 11:06:20 +0000 (13:06 +0200)
* WARNING: Bullet list ends without a blank line; unexpected unindent
* ERROR: Error in "code-block" directive (1 argument(s) required, 0 supplied.)
* ERROR: Invalid directives (typo in "code-block)
* Use of "file" role

Change-Id: Iece09cb919655fb04f9c9199f6ed71b63d476f65
Releases: master
Resolves: #67628
Reviewed-on: http://review.typo3.org/40469
Reviewed-by: Xavier Perseguers <xavier@typo3.org>
Tested-by: Xavier Perseguers <xavier@typo3.org>
20 files changed:
typo3/sysext/core/Documentation/Changelog/7.0/Breaking-61459-RemovalTslib.rst
typo3/sysext/core/Documentation/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.rst
typo3/sysext/core/Documentation/Changelog/7.1/Breaking-64059-Rewritten-JavaScript-Tree-Components.rst
typo3/sysext/core/Documentation/Changelog/7.1/Breaking-64143-FlagFilesMoved.rst
typo3/sysext/core/Documentation/Changelog/7.2/Breaking-65778-MediaWizardProviderMovedToSystemExtension.rst
typo3/sysext/core/Documentation/Changelog/7.2/Deprecation-64068-ThumbnailView.rst
typo3/sysext/core/Documentation/Changelog/7.3/Breaking-63846-FormEngineRefactoring.rst
typo3/sysext/core/Documentation/Changelog/7.3/Breaking-66429-RemoveIdentityMapFromPersistence.rst
typo3/sysext/core/Documentation/Changelog/7.3/Breaking-66868-MoveUsageOfBackendUserSettingsDataProvider.rst
typo3/sysext/core/Documentation/Changelog/7.3/Breaking-67027-RemovedFlowCompatibilityFromPackageManager.rst
typo3/sysext/core/Documentation/Changelog/7.3/Breaking-67212-DiscardLegacyClassLoader.rst
typo3/sysext/core/Documentation/Changelog/7.3/Deprecation-65344-ExtTables.rst
typo3/sysext/core/Documentation/Changelog/7.3/Feature-63561-AddTypoScriptStdWrapStrtotime.rst
typo3/sysext/core/Documentation/Changelog/7.3/Feature-66173-AllowPageTitleEditByDoubleclick.rst
typo3/sysext/core/Documentation/Changelog/7.3/Feature-66269-FluidRemoveViewHelperXmlnsAttributesAndSpecifiedHtmlTag.rst
typo3/sysext/core/Documentation/Changelog/7.3/Feature-66822-SpriteIconsInBackendModules.rst
typo3/sysext/core/Documentation/Changelog/7.3/Feature-67229-FormEngineNodeFactoryApi.rst
typo3/sysext/core/Documentation/Changelog/master/Breaking-67557-LanguageFileOfOpendocsWasMoved.rst
typo3/sysext/core/Documentation/Changelog/master/Feature-22175-SupportIecSiUnitsInFileSizeFormatting.rst
typo3/sysext/core/Documentation/Changelog/master/Feature-34922-AllowTsFileExtensionForStaticTyposcriptTemplates.rst

index 0e9fed0..9459a58 100644 (file)
@@ -16,14 +16,16 @@ Extensions that still use PATH_tslib constant, and reference typo3/sysext/cms/ts
 Affected installations
 ======================
 
-A TYPO3 instance is affected if a 3rd party extension uses index_ts.php directly, or if the main index.php is not
-replaced with the TYPO3 Update (used on certain install types). The index.php file must be replaced with the
-current version from the TYPO3 CMS Core.
+A TYPO3 instance is affected if a 3rd party extension uses :file:`index_ts.php` directly, or if the main
+:file:`index.php` is not replaced with the TYPO3 Update (used on certain install types). The index.php file must be
+replaced with the current version from the TYPO3 CMS Core.
 
-Besides scripts are affected that access the time tracking (:code:`$TT`) or typoscript frontend controller (:code:`$TSFE`) objects instead of using :code:`$GLOBALS['TT']` respectively :code:`$GLOBALS['TSFE']`.
+Besides scripts are affected that access the time tracking (:code:`$TT`) or typoscript frontend controller (:code:`$TSFE`)
+objects instead of using :code:`$GLOBALS['TT']` respectively :code:`$GLOBALS['TSFE']`.
 
 
 Migration
 =========
 
-Remove the constant PATH_tslib from the 3rd party extension, use a current version of index.php and use :code:`$GLOBALS['TT']` and :code:`$GLOBALS['TSFE']` where necessary.
\ No newline at end of file
+Remove the constant PATH_tslib from the 3rd party extension, use a current version of index.php and use :code:`$GLOBALS['TT']`
+and :code:`$GLOBALS['TSFE']` where necessary.
\ No newline at end of file
index 7d9d753..c87dd6e 100644 (file)
@@ -28,7 +28,7 @@ Removed files
 -------------
 
 * lang/lang.php is removed. You don't need to include this file anymore, just use :code:`\TYPO3\CMS\Lang\LanguageService` directly.
-* rtehtmlarea/htmlarea/plugins/DynamicCSS/dynamiccss.css is removed. The file was not used.
+* :file:`rtehtmlarea/htmlarea/plugins/DynamicCSS/dynamiccss.css` is removed. The file was not used.
 
 
 Removed PHP classes
index d867156..ec65541 100644 (file)
@@ -11,15 +11,15 @@ drag&drop parts have been migrated to a RequireJS / jQuery module.
 The page tree filter functionality of the prototype tree, which is not used in the TYPO3 core, was removed from the
 tree component.
 
-The file typo3/js/tree.js has been removed, the replacement code, based on jQuery is located under
+The file :file:`typo3/js/tree.js` has been removed, the replacement code, based on jQuery is located under
 EXT:backend/Resources/Public/JavaScript/LegacyTree.js.
 
 
 Impact
 ======
 
-Any usages in third party extensions that include js/tree.js will fail, as the tree component has been removed. Any
-extension using the filter part of the tree.js component will not work.
+Any usages in third party extensions that include :file:`js/tree.js` will fail, as the tree component has been removed.
+Any extension using the filter part of the tree.js component will not work.
 
 
 Affected installations
@@ -32,5 +32,5 @@ Migration
 =========
 
 Rewrite any needed logic for filtering, and include the RequireJS module like in e.g.
-FileSystemNavigationFrameController.php, to use the tree component. If the old code is needed, the tree.js file
+FileSystemNavigationFrameController.php, to use the tree component. If the old code is needed, the :file:`tree.js` file
 and prototype need to be included as part of the extension, not from the core.
index 1108af9..5be33ea 100644 (file)
@@ -5,20 +5,21 @@ Breaking: #64143 - Language / Country Flag files moved
 Description
 ===========
 
-The static GIF file collection representing flags within typo3/gfx/flags/ has been removed. All PNG flag images from
-EXT:t3skin are moved from typo3/sysext/t3skin/images/flags/ to typo3/sysext/core/Resources/Public/Icons/flags/. The
-according stylesheets for the that flags-* icon files have been moved to EXT:core as well.
+The static GIF file collection representing flags within :file:`typo3/gfx/flags/` has been removed. All PNG flag images
+from EXT:t3skin are moved from :file:`typo3/sysext/t3skin/images/flags/` to
+:file:`typo3/sysext/core/Resources/Public/Icons/flags/`. The according stylesheets for the that :file:`flags-*` icon
+files have been moved to EXT:core as well.
 
 Impact
 ======
 
-Any hard-coded reference on any of the files within typo3/gfx/flags/ and typo3/sysext/core/Resources/Public/Icons/flags/
-will result in an error.
+Any hard-coded reference on any of the files within :file:`typo3/gfx/flags/` and
+:file:`typo3/sysext/core/Resources/Public/Icons/flags/` will result in an error.
 
 Changing the EXT:t3skin flags sprite now means changing the flags sprite of EXT:core.
 
 Affected installations
 ======================
 
-Any installation using third-party extensions that access typo3/gfx/flags/ or
-typo3/sysext/t3skin/images/flags/ will fail.
+Any installation using third-party extensions that access :file:`typo3/gfx/flags/` or
+:file:`typo3/sysext/t3skin/images/flags/` will fail.
index 60fceff..9879f03 100644 (file)
@@ -25,4 +25,4 @@ Migration
 =========
 
 Make sure to install the system extension "mediace" and rename the function calls to use the new classes, see
-the file ``ext_localconf.php`` of the extension "mediace" for example usage.
+the file :file:`ext_localconf.php` of the extension "mediace" for example usage.
index 8f03d98..c3a6b1f 100644 (file)
@@ -5,7 +5,7 @@ Deprecation: #64068 - Deprecate thumbs.php and ThumbnailView
 Description
 ===========
 
-Prior to the File Abstraction Layer (FAL) there was typo3/thumbs.php generating all preview images for the TYPO3
+Prior to the File Abstraction Layer (FAL) there was :file:`typo3/thumbs.php` generating all preview images for the TYPO3
 Backend resources. This functionality is now marked for removal in TYPO3 CMS 8, as all functionality in the core already
 uses the File Abstraction Layer.
 
index 6e8f9f2..624afd1 100644 (file)
@@ -20,7 +20,7 @@ TCA changes
 -----------
 
 * Keys `_PADDING`, `_VALIGN` and `DISTANCE` of `TCA['aTable']['columns']['aField']['config']['wizards']`
-have been removed and have no effect anymore.
+  have been removed and have no effect anymore.
 
 * Key `TCA['aTable']['ctrl']['mainPalette']` has been dropped and has no effect anymore.
 
@@ -45,10 +45,10 @@ Changed user functions and hooks
 --------------------------------
 
 * TCA: If format of type `none` is set to `user`, the configured userFunc no longer gets an instance of `FormEngine`
-as parent object, but an instance of `NoneElement``.
+  as parent object, but an instance of `NoneElement``.
 
 * TCA: Wizards configured as `userFunc` now receive a dummy `FormEngine` object with empty properties instead
-of the real instance.
+  of the real instance.
 
 * Hooks no longer get the key `form_type`. Use `type` instead.
 
@@ -58,10 +58,10 @@ Breaking interface changes
 --------------------------
 
 * The type hint to `FormEngine` as `$pObj` has been removed on the `DatabaseFileIconsHookInterface`.
-This hook is no longer given an instance of `FormEngine`.
+  This hook is no longer given an instance of `FormEngine`.
 
 * Method `init()` of `InlineElementHookInterface` has been removed. Classes that implement this interface will
-no longer get `init()` called.
+  no longer get `init()` called.
 
 
 Affected installations
index 19b8454..41b829d 100644 (file)
@@ -1,5 +1,5 @@
 ======================================================
-Breaking - #66429: Remove IdentityMap from persistence
+Breaking: #66429 - Remove IdentityMap from persistence
 ======================================================
 
 Description
@@ -31,6 +31,7 @@ The Extbase reflection cache of existing installations needs to be cleared once.
 Existing code can be migrated to the persistence ``Session`` class which provides a drop-in replacement for the
 ``IdentityMap``.
 
+
 Usage example
 =============
 
index 45d75c9..531f833 100644 (file)
@@ -25,7 +25,7 @@ Migration
 
 In JavaScript, use `TYPO3.Storage.Persistent` API. In PHP, use `\TYPO3\CMS\Backend\Controller\UserSettingsController`:
 
-.. code-block:: [php]
+.. code-block:: php
 
        /** @var $userSettingsController \TYPO3\CMS\Backend\Controller\UserSettingsController */
        $userSettingsController = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Controller\UserSettingsController::class);
index 44eab68..906c545 100644 (file)
@@ -16,8 +16,8 @@ Impact
 
 It is not possible to add custom Package.php loaders into TYPO3 extensions anymore to be called during runtime. It is
 not possible to configure extensions with custom `Classes/` directories and custom composer.json locations anymore.
-There is no special handling for "typo3-flow" packages anymore. The typo3conf/PackageStates.php file now only contains
-the parts that are necessary for the TYPO3 system.
+There is no special handling for "typo3-flow" packages anymore. The :file:`typo3conf/PackageStates.php` file now only
+contains the parts that are necessary for the TYPO3 system.
 
 
 Affected Installations
index 654c7db..33d0a2c 100644 (file)
@@ -15,17 +15,17 @@ ext_autoload.php files are **not** evaluated any more. Instead all class files a
 automatically during extension installation and written into a class map file. This class map file is
 not changed during regular requests, but only if the extension list changes (by using the Extension Manager).
 
-These class information files are located in the typo3temp/autoload/ directory and will also be automatically created
-if they do not exist.
+These class information files are located in the :file:`typo3temp/autoload/` directory and will also be automatically
+created if they do not exist.
 
-Non-namespaced classes with Tx\_ naming convention like Tx_Extension_ClassName are only resolved through
+Non-namespaced classes with ``Tx_`` naming convention like ``Tx_Extension_ClassName`` are only resolved through
 the aforementioned class map, but not dynamically. This means that extension authors need to re-generate the class map
 files when introducing new classes. Thus it is highly recommended to use a Classes folder with PSR-4 standard class
 files in there.
 
-When installing TYPO3 with composer, it also means that all extensions need to bring their own composer.json file with
-class loading information or the class loading information of all extensions need to be specified in the root
-composer.json for class loading to work properly.
+When installing TYPO3 with composer, it also means that all extensions need to bring their own :file:`composer.json`
+file with class loading information or the class loading information of all extensions need to be specified in the root
+:file:`composer.json` for class loading to work properly.
 
 
 Affected Installations
@@ -41,7 +41,7 @@ No migration is needed during upgrade if TYPO3 is installed in the classic way.
 If TYPO3 is installed in a distribution via composer, missing class loading information need to be provided in root
 composer.json for all extensions which do not bring their own composer.json manifest.
 
-.. code-block::
+.. code-block:: json
 
     {
         "autoload": {
index 60a67e0..5d9f534 100644 (file)
@@ -5,7 +5,7 @@ Deprecation: #65344 - typo3conf/extTables.php deprecated
 Description
 ===========
 
-The file ``typo3conf/extTables.php`` which could be used for local TCA modifications has been marked as deprecated.
+The file :file:`typo3conf/extTables.php` which could be used for local TCA modifications has been marked as deprecated.
 
 Setting ``$GLOBALS['TYPO3_CONF_VARS']['DB']['extTablesDefinitionScript']`` together with the constant
 ``TYPO3_extTableDef_script`` are deprecated and should not be used any longer.
@@ -24,8 +24,8 @@ Migration
 There are two options to migrate away from ``typo3conf/extTables.php`` usage, the first one should be preferred:
 
 * It is good practice to have a project / site specific extension that contains templates, TypoScript and
-other stuff. Create one or more dedicated extensions and use TCA overrides to apply the desired modifications.
-Something like ``$GLOBALS['TCA']['pages']['ctrl']['hideAtCopy'] = FALSE;`` should be moved from ``typo3conf/extTables.php``
-to ``typo3conf/ext/<your_extension>/Configuration/TCA/Overrides/pages.php``.
+  other stuff. Create one or more dedicated extensions and use TCA overrides to apply the desired modifications.
+  Something like ``$GLOBALS['TCA']['pages']['ctrl']['hideAtCopy'] = FALSE;`` should be moved from
+  :file:`typo3conf/extTables.php` to :file:`typo3conf/ext/<your_extension>/Configuration/TCA/Overrides/pages.php`.
 
 * Slot the signal ``tcaIsBeingBuilt`` that is emitted in ``ExtensionManagementUtility.php``.
\ No newline at end of file
index db632b2..4200484 100644 (file)
@@ -1,5 +1,5 @@
 ==================================================
-Feature - #63561: Add TypoScript stdWrap strtotime
+Feature: #63561 - Add TypoScript stdWrap strtotime
 ==================================================
 
 Description
index 03e7ab9..82bd453 100644 (file)
@@ -1,5 +1,5 @@
 ======================================================
-Feature - #66173: Allow page title edit by doubleclick
+Feature: #66173 - Allow page title edit by doubleclick
 ======================================================
 
 Description
index e171e0f..75593f9 100644 (file)
@@ -1,5 +1,5 @@
 ==================================================================================
-Feature - #66269: Fluid: Remove ViewHelper xmlns-attributes and specified html tag
+Feature: #66269 - Fluid: Remove ViewHelper xmlns-attributes and specified html tag
 ==================================================================================
 
 Description
index a52c09d..7355cc7 100644 (file)
@@ -10,7 +10,7 @@ displaying the icons in the module menu on the left side of the TYPO3 Backend.
 
 Registering a module can now look like this (as an example the "Page" module):
 
-.. code-block:: [php]
+.. code-block:: php
 
        \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addModule(
                'web',
index 0e43232..dcd3eb2 100644 (file)
@@ -15,7 +15,7 @@ This class was extended with an API to allow flexible overriding and adding of c
 Registration of new nodes and overwriting existing nodes
 --------------------------------------------------------
 
-.. code-black:: php
+.. code-block:: php
 
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['formEngine']['nodeRegistry'][1433196792] = array(
                'nodeName' => 'input',
index d2415d3..3ff8715 100644 (file)
@@ -5,22 +5,24 @@ Breaking: #67557 - Language file of Opendocs was moved
 Description
 ===========
 
-The language file locallang_opendocs.xlf of EXT:opendocs has been moved to Resources/Private/locallang.xlf.
+The language file :file:`locallang_opendocs.xlf` of EXT:opendocs has been moved to
+:file:`Resources/Private/locallang.xlf`.
 
 
 Impact
 ======
 
-Inclusion of the file via ``$this->getLanguageService()->includeLLFile()`` or usage in ``<f:translate key="LLL:EXT:opendocs/locallang_opendocs.xlf:foobar" />.`` will fail.
+Inclusion of the file via ``$this->getLanguageService()->includeLLFile()`` or usage in
+``<f:translate key="LLL:EXT:opendocs/locallang_opendocs.xlf:foobar" />.`` will fail.
 
 
 Affected Installations
 ======================
 
-Every extension relying on the existence of locallang_opendocs.xlf will be affected.
+Every extension relying on the existence of :file:`locallang_opendocs.xlf` will be affected.
 
 
 Migration
 =========
 
-Use Resources/Private/Language/locallang.xlf, if required.
\ No newline at end of file
+Use :file:`Resources/Private/Language/locallang.xlf`, if required.
\ No newline at end of file
index dacd7ed..7a4c260 100644 (file)
@@ -31,7 +31,8 @@ to `` | k| M| G| T| P| E| Z| Y`` (based on ten).
 Example
 =======
 
-.. codeblock:: php
+.. code-block:: php
+
        echo GeneralUtility::formatSize(85123);
        // => Before "83.1 K"
        // => Now "83.13 Ki"
index fb3aa7e..fd401be 100644 (file)
@@ -6,6 +6,7 @@ Description
 ===========
 
 Only these TypoScript file names were allowed:
+
 - constants.txt
 - setup.txt
 - include_static.txt
@@ -17,4 +18,5 @@ The ts file extension has been allowed for constants and setup and is prioritise
 Impact
 ======
 
-There is a little performance impact when loading the TypoScript from scratch like in the backend and frontend without cache as the new extension is always tested.
+There is a little performance impact when loading the TypoScript from scratch like in the backend and frontend without
+cache as the new extension is always tested.