Commit b3187510 authored by Lina Wolf's avatar Lina Wolf Committed by Christian Kuhn
Browse files

[BUGFIX] Fix sphinx warnings in previous changelog entries

Fixes Layout problems: Malformed lists, malformed
headlines, non-working links to documentation or
other changelogs.
Directive `:ts:` and `.. code-block:: ts` is only
used for typescript, exchanged it into `:typoscript:`
for typoscript examples.

Resolves: #94534
Releases: master, 10.4, 9.5
Change-Id: I61e3c5910d6a5bc97f1ec887ce5b2c1e6d59a2db
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/69922


Tested-by: Simon Gilli's avatarSimon Gilli <typo3@gilbertsoft.org>
Tested-by: core-ci's avatarcore-ci <typo3@b13.com>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Simon Gilli's avatarSimon Gilli <typo3@gilbertsoft.org>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
parent bf8c6585
...@@ -20,14 +20,14 @@ Input ...@@ -20,14 +20,14 @@ Input
.. code-block:: yaml .. code-block:: yaml
editor: editor:
externalPlugins: externalPlugins:
myplugin: myplugin:
resource: "EXT:my_extension/Resources/Public/JavaScript/Contrib/plugins/myplugin/" resource: "EXT:my_extension/Resources/Public/JavaScript/Contrib/plugins/myplugin/"
route: "myroute" route: "myroute"
configName: "super_config" configName: "super_config"
option1: "value1" option1: "value1"
option2: "value2" option2: "value2"
option3: "value3" option3: "value3"
Output Output
...@@ -38,15 +38,16 @@ Output ...@@ -38,15 +38,16 @@ Output
'typo3conf/ext/my_extension/Resources/Public/JavaScript/Contrib/plugins/myplugin/' 'typo3conf/ext/my_extension/Resources/Public/JavaScript/Contrib/plugins/myplugin/'
); );
.. code-block:: json .. code-block:: yaml
editor: editor:
config: config:
super_config: super_config:
route: "myroute" route: "myroute"
routeUrl: "/typo3/index.php?route=myroute" routeUrl: "/typo3/index.php?route=myroute"
option1: "value1" option1: "value1"
option2: "value2" option2: "value2"
option3: "value3" option3: "value3"
option3: "value3"
.. index:: JavaScript, RTE, ext:rte_ckeditor .. index:: JavaScript, RTE, ext:rte_ckeditor
...@@ -11,21 +11,21 @@ Description ...@@ -11,21 +11,21 @@ Description
The following properties within TypoScriptFrontendController have been marked as deprecated: The following properties within TypoScriptFrontendController have been marked as deprecated:
* :php:`$compensateFieldWidth` * :php:`$compensateFieldWidth`
* :php:`$excludeCHashVars` * :php:`$excludeCHashVars`
* :php:`$scriptParseTime` * :php:`$scriptParseTime`
The following methods have been marked as deprecated: The following methods have been marked as deprecated:
* :php:`TypoScriptFrontendController->generatePage_whichScript()` (used via :ts:`config.pageGenScript`) * :php:`TypoScriptFrontendController->generatePage_whichScript()` (used via :typoscript:`config.pageGenScript`)
* :php:`TypoScriptFrontendController->encryptEmail()` * :php:`TypoScriptFrontendController->encryptEmail()`
* :php:`TypoScriptFrontendController->encryptCharcode()` * :php:`TypoScriptFrontendController->encryptCharcode()`
* :php:`PageGenerator::pagegenInit()` * :php:`PageGenerator::pagegenInit()`
The following TypoScript properties have been marked as deprecated: The following TypoScript properties have been marked as deprecated:
* :typoscript:`config.pageGenScript` * :typoscript:`config.pageGenScript`
* :typoscript:`config.compensateFieldWidth` * :typoscript:`config.compensateFieldWidth`
Impact Impact
...@@ -49,22 +49,22 @@ Migration ...@@ -49,22 +49,22 @@ Migration
All of the functionality is obsolete or outdated and should be handled differently from now on: All of the functionality is obsolete or outdated and should be handled differently from now on:
1. The :typoscript:`compensateFieldWidth` option was used for forms built with TYPO3 4.x (before TYPO3 4.6), 1. The :typoscript:`compensateFieldWidth` option was used for forms built with TYPO3 4.x (before TYPO3 4.6),
instead, any other form framework should be used for forms and for field width calculations, where instead, any other form framework should be used for forms and for field width calculations, where
styling of form fields are also handled via CSS. styling of form fields are also handled via CSS.
2. An alternative :typoscript:`config.pageGenScript` can be used and set via hooks in PHP classes nowadays and 2. An alternative :typoscript:`config.pageGenScript` can be used and set via hooks in PHP classes nowadays and
executed, instead of configuring this functionality on a high-end TypoScript level to execute include executed, instead of configuring this functionality on a high-end TypoScript level to execute include
spaghetti PHP code within a file. spaghetti PHP code within a file.
3. :php:`PageGenerator::pagegenInit()` is solely working on public properties of the TSFE PHP class, which 3. :php:`PageGenerator::pagegenInit()` is solely working on public properties of the TSFE PHP class, which
belongs to the TSFE object itself (thus, the logic is copied to :php:`$TSFE->preparePageContentGeneration()`) belongs to the TSFE object itself (thus, the logic is copied to :php:`$TSFE->preparePageContentGeneration()`)
4. Calculating the debug parse time for the web page is not part of the controller logic but more 4. Calculating the debug parse time for the web page is not part of the controller logic but more
certainly belongs to the request handling itself, where it is handled in a cleaner way for PHP, certainly belongs to the request handling itself, where it is handled in a cleaner way for PHP,
waiting for further refactorings in TYPO3 v9. waiting for further refactorings in TYPO3 v9.
5. The methods :php:`TypoScriptFrontendController->encryptEmail()` and :php:`encryptCharcode()` have been moved 5. The methods :php:`TypoScriptFrontendController->encryptEmail()` and :php:`encryptCharcode()` have been moved
to ContentObjectRenderer. to ContentObjectRenderer.
.. index:: Frontend, TypoScript, PHP-API .. index:: Frontend, TypoScript, PHP-API
...@@ -9,7 +9,7 @@ See :issue:`82701` ...@@ -9,7 +9,7 @@ See :issue:`82701`
Description Description
=========== ===========
The TSconfig option :ts:`options.workspaces.considerReferences` to disable references when publishing The TSconfig option :typoscript:`options.workspaces.considerReferences` to disable references when publishing
records from a workspace has been removed. records from a workspace has been removed.
The according method :php:`TYPO3\CMS\Version\DataHandler\CommandMap::setWorkspacesConsiderReferences()` The according method :php:`TYPO3\CMS\Version\DataHandler\CommandMap::setWorkspacesConsiderReferences()`
......
...@@ -32,7 +32,7 @@ Migration ...@@ -32,7 +32,7 @@ Migration
========= =========
The "no cache" option which should be avoided or otherwise used carefully by integrators via The "no cache" option which should be avoided or otherwise used carefully by integrators via
TypoScript through :ts:`config.no_cache = 1` in conjunction with a condition on a per-page basis. TypoScript through :typoscript:`config.no_cache = 1` in conjunction with a condition on a per-page basis.
However, it is better to set a very low cache timeout, or investigate why caching is configured However, it is better to set a very low cache timeout, or investigate why caching is configured
wrongly in an extension or plugin. wrongly in an extension or plugin.
...@@ -42,7 +42,7 @@ If not, it is not necessary to migrate anything: ...@@ -42,7 +42,7 @@ If not, it is not necessary to migrate anything:
.. code-block:: sql .. code-block:: sql
SELECT uid,title FROM pages WHERE no_cache = 1 SELECT uid,title FROM pages WHERE no_cache = 1
.. index:: Database, Frontend, NotScanned .. index:: Database, Frontend, NotScanned
...@@ -11,10 +11,10 @@ Description ...@@ -11,10 +11,10 @@ Description
The following edge-case TSconfig options have been removed: The following edge-case TSconfig options have been removed:
- :ts:`options.pageTree.disableIconLinkToContextmenu` (Icons are always linked) - :typoscript:`options.pageTree.disableIconLinkToContextmenu` (Icons are always linked)
- :ts:`options.pageTree.searchInAlias` (the pages.alias DB field is now always respected when filtering) - :typoscript:`options.pageTree.searchInAlias` (the pages.alias DB field is now always respected when filtering)
- :ts:`options.pageTree.excludeDoktypes` (there is no restriction to doctypes in the filter anymore) - :typoscript:`options.pageTree.excludeDoktypes` (there is no restriction to doctypes in the filter anymore)
- :ts:`options.pageTree.hideFilter` (filter is now always visible) - :typoscript:`options.pageTree.hideFilter` (filter is now always visible)
Impact Impact
...@@ -28,4 +28,4 @@ Affected Installations ...@@ -28,4 +28,4 @@ Affected Installations
Installations having one of these options set. Installations having one of these options set.
.. index:: Backend, TSConfig, NotScanned .. index:: Backend, TSConfig, NotScanned
\ No newline at end of file
...@@ -9,13 +9,13 @@ See :issue:`83124` ...@@ -9,13 +9,13 @@ See :issue:`83124`
Description Description
=========== ===========
The stdWrap options :ts:`space`, :ts:`spaceBefore`, :ts:`spaceAfter` are rarely used and should be better done completely by CSS. The stdWrap options :typoscript:`space`, :typoscript:`spaceBefore`, :typoscript:`spaceAfter` are rarely used and should be better done completely by CSS.
Impact Impact
====== ======
The stdWrap options :ts:`space`, :ts:`spaceBefore`, :ts:`spaceAfter` do not work anymore. The following calls to :php:`\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer` will trigger an error: The stdWrap options :typoscript:`space`, :typoscript:`spaceBefore`, :typoscript:`spaceAfter` do not work anymore. The following calls to :php:`\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer` will trigger an error:
- :php:`stdWrap_spaceBefore` - :php:`stdWrap_spaceBefore`
- :php:`stdWrap_spaceAfter` - :php:`stdWrap_spaceAfter`
...@@ -25,7 +25,7 @@ The stdWrap options :ts:`space`, :ts:`spaceBefore`, :ts:`spaceAfter` do not work ...@@ -25,7 +25,7 @@ The stdWrap options :ts:`space`, :ts:`spaceBefore`, :ts:`spaceAfter` do not work
Affected Installations Affected Installations
====================== ======================
Any instance using the stdWrap option :ts:`space`, :ts:`spaceBefore`, :ts:`spaceAfter` or calls to :php:`\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer` : Any instance using the stdWrap option :typoscript:`space`, :typoscript:`spaceBefore`, :typoscript:`spaceAfter` or calls to :php:`\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer` :
- :php:`stdWrap_spaceBefore` - :php:`stdWrap_spaceBefore`
- :php:`stdWrap_spaceAfter` - :php:`stdWrap_spaceAfter`
......
...@@ -39,7 +39,7 @@ Affected Installations ...@@ -39,7 +39,7 @@ Affected Installations
====================== ======================
Any installation using the PHP method/property or having config.lockFilePath set to a specific non-FAL folder, Any installation using the PHP method/property or having config.lockFilePath set to a specific non-FAL folder,
and using :ts:`stdWrap.filelist` functionality. and using :typoscript:`stdWrap.filelist` functionality.
Migration Migration
......
...@@ -9,7 +9,7 @@ See :issue:`83265` ...@@ -9,7 +9,7 @@ See :issue:`83265`
Description Description
=========== ===========
The functionality to add the possible page :ts:`typeNum` to the "id" GET/POST Parameter has been removed. The functionality to add the possible page :typoscript:`typeNum` to the "id" GET/POST Parameter has been removed.
Previously it was possible to call TYPO3 Frontend via `index.php?id=23.13` (separated with a dot) Previously it was possible to call TYPO3 Frontend via `index.php?id=23.13` (separated with a dot)
which resolved in the page ID being "23" and the typeNum set to 13. which resolved in the page ID being "23" and the typeNum set to 13.
...@@ -37,4 +37,4 @@ Migration ...@@ -37,4 +37,4 @@ Migration
Use typolink functionality in TypoScript, or Fluid to build your URLs properly in the format Use typolink functionality in TypoScript, or Fluid to build your URLs properly in the format
of `index.php?id=pageId&type=typeNum`. of `index.php?id=pageId&type=typeNum`.
.. index:: Frontend, NotScanned .. index:: Frontend, NotScanned
\ No newline at end of file
...@@ -9,19 +9,19 @@ See :issue:`70526` ...@@ -9,19 +9,19 @@ See :issue:`70526`
Description Description
=========== ===========
Since its introduction, the option :ts:`formatToPageTypeMapping` had to be configured in :ts:`settings.view.formatToPageTypeMapping` instead of :ts:`view.formatToPageTypeMapping`. This has been marked as deprecated. Since its introduction, the option :typoscript:`formatToPageTypeMapping` had to be configured in :typoscript:`settings.view.formatToPageTypeMapping` instead of :typoscript:`view.formatToPageTypeMapping`. This has been marked as deprecated.
Impact Impact
====== ======
Defining :ts:`settings.view.formatToPageTypeMapping` will trigger a deprecation log entry. Defining :typoscript:`settings.view.formatToPageTypeMapping` will trigger a deprecation log entry.
Affected Installations Affected Installations
====================== ======================
Installations containing plugins that define :ts:`settings.view.formatToPageTypeMapping` instead of :ts:`view.formatToPageTypeMapping`. Installations containing plugins that define :typoscript:`settings.view.formatToPageTypeMapping` instead of :typoscript:`view.formatToPageTypeMapping`.
Migration Migration
...@@ -31,12 +31,12 @@ Move ...@@ -31,12 +31,12 @@ Move
.. code-block:: typoscript .. code-block:: typoscript
plugin.tx_myextension.settings.view.formatToPageTypeMapping plugin.tx_myextension.settings.view.formatToPageTypeMapping
to to
.. code-block:: typoscript .. code-block:: typoscript
plugin.tx_myextension.view.formatToPageTypeMapping plugin.tx_myextension.view.formatToPageTypeMapping
.. index:: Frontend, TypoScript, NotScanned .. index:: Frontend, TypoScript, NotScanned
...@@ -9,7 +9,7 @@ See :issue:`82909` ...@@ -9,7 +9,7 @@ See :issue:`82909`
Description Description
=========== ===========
The TypoScript option :ts:`config.typolinkCheckRootline` is now always active. The TypoScript option :typoscript:`config.typolinkCheckRootline` is now always active.
Impact Impact
...@@ -29,4 +29,4 @@ Migration ...@@ -29,4 +29,4 @@ Migration
Just remove the TypoScript instruction, as it is not needed anymore. Just remove the TypoScript instruction, as it is not needed anymore.
.. index:: TypoScript, Frontend, NotScanned .. index:: TypoScript, Frontend, NotScanned
\ No newline at end of file
...@@ -12,17 +12,17 @@ Description ...@@ -12,17 +12,17 @@ Description
It is now possible to add the HTML attribute :html:`crossorigin="some-value"` to <script> tags for It is now possible to add the HTML attribute :html:`crossorigin="some-value"` to <script> tags for
Frontend rendering via TypoScript with the following new property Frontend rendering via TypoScript with the following new property
:ts:`page.includeJSlibs.<array>.crossorigin = some-value` :typoscript:`page.includeJSlibs.<array>.crossorigin = some-value`
The ``crossorigin`` property is automatically set to the value ``anonymous`` for The ``crossorigin`` property is automatically set to the value ``anonymous`` for
external JavaScript files with an ``integrity`` property if not explicitly set. external JavaScript files with an ``integrity`` property if not explicitly set.
The feature is available within the following TypoScript PAGE properties The feature is available within the following TypoScript PAGE properties
* :ts:`includeJSlibs` * :typoscript:`includeJSlibs`
* :ts:`includeJSFooterlibs` * :typoscript:`includeJSFooterlibs`
* :ts:`includeJS` * :typoscript:`includeJS`
* :ts:`includeJSFooter` * :typoscript:`includeJSFooter`
Usage: Usage:
------ ------
...@@ -30,14 +30,14 @@ Usage: ...@@ -30,14 +30,14 @@ Usage:
.. code-block:: typoscript .. code-block:: typoscript
page { page {
includeJS { includeJS {
jQuery = https://code.jquery.com/jquery-2.2.4.min.js jQuery = https://code.jquery.com/jquery-2.2.4.min.js
jQuery.external = 1 jQuery.external = 1
jQuery.disableCompression = 1 jQuery.disableCompression = 1
jQuery.excludeFromConcatenation = 1 jQuery.excludeFromConcatenation = 1
jQuery.integrity = sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44= jQuery.integrity = sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=
jQuery.crossorigin = anonymous jQuery.crossorigin = anonymous
} }
} }
.. index:: Frontend, TypoScript, JavaScript .. index:: Frontend, TypoScript, JavaScript
...@@ -9,34 +9,34 @@ See :issue:`81223` ...@@ -9,34 +9,34 @@ See :issue:`81223`
Description Description
=========== ===========
A property :ts:`.inline` has been added to :ts:`page.includeCSS`. A property :typoscript:`.inline` has been added to :typoscript:`page.includeCSS`.
If :ts:`.inline` is set, the content of the css-file is inlined using <style>-tags. If :typoscript:`.inline` is set, the content of the css-file is inlined using <style>-tags.
Impact Impact
====== ======
Example: Example:
.. code-block:: typoscript .. code-block:: typoscript
page.includeCSS { page.includeCSS {
inline = EXT:test/Resources/Public/Css/inline.css inline = EXT:test/Resources/Public/Css/inline.css
inline { inline {
inline = 1 inline = 1
forceOnTop = 1 forceOnTop = 1
media = all media = all
} }
other = EXT:test/Resources/Public/Css/other.css other = EXT:test/Resources/Public/Css/other.css
} }
Some notes on the implementation: Some notes on the implementation:
External files are not inlined. External files are not inlined.
The inline-css is compressed if :ts:`config.compressCss` is set. The inline-css is compressed if :typoscript:`config.compressCss` is set.
Most other properties (:ts:`.allWrap`, :ts:`.disableCompression`, :ts:`.forceOnTop`, :ts:`.if`, Most other properties (:typoscript:`.allWrap`, :typoscript:`.disableCompression`, :typoscript:`.forceOnTop`, :typoscript:`.if`,
:ts:`.media`, :ts:`.title`) work even if :ts:`.inline` is set. :typoscript:`.media`, :typoscript:`.title`) work even if :typoscript:`.inline` is set.
If :ts:`.import` and :ts:`.inline` are both set , the file is loaded via @import. If :typoscript:`.import` and :typoscript:`.inline` are both set , the file is loaded via @import.
.. index:: Frontend, TypoScript .. index:: Frontend, TypoScript
...@@ -11,7 +11,7 @@ Description ...@@ -11,7 +11,7 @@ Description
The SVG content object supports a new option to render a SVG file as :html:`<svg>` tag. The SVG content object supports a new option to render a SVG file as :html:`<svg>` tag.
The new setting :typoscript:`renderMode` can be set to `inline` to render an inline version of the SVG file. The new setting :typoscript:`renderMode` can be set to `inline` to render an inline version of the SVG file.
The :ts:`renderMode` property additionally has :ts:`stdWrap` capabilities. The :typoscript:`renderMode` property additionally has :typoscript:`stdWrap` capabilities.
.. code-block:: typoscript .. code-block:: typoscript
......
...@@ -15,7 +15,7 @@ Method :php:`TYPO3\CMS\Core\Authentication\BackendUserAuthentication->addTScomme ...@@ -15,7 +15,7 @@ Method :php:`TYPO3\CMS\Core\Authentication\BackendUserAuthentication->addTScomme
Impact Impact
====== ======
The method has been used to add comments to :ts:`TSconfig` at runtime, those The method has been used to add comments to :typoscript:`TSconfig` at runtime, those
comments however are never shown in the TYPO3 backend. comments however are never shown in the TYPO3 backend.
Calling the method directly will trigger a PHP :php:`E_USER_DEPRECATED` error. Calling the method directly will trigger a PHP :php:`E_USER_DEPRECATED` error.
...@@ -35,4 +35,4 @@ Migration ...@@ -35,4 +35,4 @@ Migration
Drop the method call. Drop the method call.
.. index:: Backend, PHP-API, TSConfig, FullyScanned .. index:: Backend, PHP-API, TSConfig, FullyScanned
\ No newline at end of file
...@@ -10,38 +10,38 @@ Description ...@@ -10,38 +10,38 @@ Description
=========== ===========
Overriding page TSconfig properties on a backend user or group basis is usually Overriding page TSconfig properties on a backend user or group basis is usually
done by prefixing the page TSconfig path with :ts:`page.` in user TSconfig. done by prefixing the page TSconfig path with :typoscript:`page.` in user TSconfig.
As an exception, properties within the page TSconfig top level object :ts:`mod.` could As an exception, properties within the page TSconfig top level object :typoscript:`mod.` could
sometimes also be overridden in user TSconfig using :ts:`mod.` and omitting :ts:`page.`. This sometimes also be overridden in user TSconfig using :typoscript:`mod.` and omitting :typoscript:`page.`. This
has been deprecated: :ts:`mod.` now needs to be overridden in user TSconfig by prefixing has been deprecated: :typoscript:`mod.` now needs to be overridden in user TSconfig by prefixing
the path with :ts:`page.`, too. the path with :typoscript:`page.`, too.
Impact Impact
====== ======
User TSconfig paths that start with :ts:`mod.` will trigger a PHP :php:`E_USER_DEPRECATED` error and will User TSconfig paths that start with :typoscript:`mod.` will trigger a PHP :php:`E_USER_DEPRECATED` error and will
stop working with core v10. stop working with core v10.
Affected Installations Affected Installations
====================== ======================
Instances that set TSconfig on backend user or group basis starting with :ts:`mod.`. Instances that set TSconfig on backend user or group basis starting with :typoscript:`mod.`.
Migration Migration
========= =========
Simply prefix the user TSconfig path with :ts:`page.` as usual if overriding page TSconfig