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
.. include:: ../../Includes.txt .. include:: ../../Includes.txt
=========================================================================================== ============================================================================================
Feature: #84250 - Separately enable / disable "Add media by URL" and "Select & upload files" Feature: #84250 - Separately enable / disable "Add media by URL" and "Select & upload files"
=========================================================================================== ============================================================================================
See :issue:`84250` See :issue:`84250`
...@@ -11,8 +11,8 @@ Description ...@@ -11,8 +11,8 @@ Description
A new appearance property "fileByUrlAllowed" is used to separately enable / disable the buttons "Add media by URL" and "Select & upload files". A new appearance property "fileByUrlAllowed" is used to separately enable / disable the buttons "Add media by URL" and "Select & upload files".
* :php:`fileUploadAllowed = false` now only hides the button "Select & upload files". * :php:`fileUploadAllowed = false` now only hides the button "Select & upload files".
* :php:`fileByUrlAllowed = false` now hides the button "Add media by URL". * :php:`fileByUrlAllowed = false` now hides the button "Add media by URL".
If "elementBrowserType" is set to "file" both values are true by default. If "elementBrowserType" is set to "file" both values are true by default.
......
...@@ -14,8 +14,8 @@ This makes it easier to check if the correct context is provided. ...@@ -14,8 +14,8 @@ This makes it easier to check if the correct context is provided.
Output example: Output example:
.. code-block:: plain .. code-block:: none
TYPO3 CMS 10.1.0-dev (Application Context: Development/Docker) TYPO3 CMS 10.1.0-dev (Application Context: Development/Docker)
.. index:: CLI, ext:core .. index:: CLI, ext:core
...@@ -14,7 +14,7 @@ on the edit icon for a broken link in order to edit the record directly. ...@@ -14,7 +14,7 @@ on the edit icon for a broken link in order to edit the record directly.
If the record was edited, the list of broken links may no longer be up to date. If the record was edited, the list of broken links may no longer be up to date.
There are now 2 possibilities, depending on how :ref:`actionAfterEditRecord <actionAfterEditRecord>` There are now 2 possibilities, depending on how :php:`actionAfterEditRecord`
is configured: is configured:
recheck (default): recheck (default):
......
...@@ -19,7 +19,7 @@ Examples ...@@ -19,7 +19,7 @@ Examples
Match the current workspace id: Match the current workspace id:
.. code-block:: ts .. code-block:: typoscript
[workspace.workspaceId === 3] [workspace.workspaceId === 3]
# Current workspace id equals: 3 # Current workspace id equals: 3
...@@ -27,7 +27,7 @@ Match the current workspace id: ...@@ -27,7 +27,7 @@ Match the current workspace id:
Match against current workspace state: Match against current workspace state:
.. code-block:: ts .. code-block:: typoscript
[workspace.isLive] [workspace.isLive]
# Current workspace is live # Current workspace is live
......
...@@ -21,18 +21,18 @@ Example ...@@ -21,18 +21,18 @@ Example
An example usage could look like this: An example usage could look like this:
.. code-block:: ts .. code-block:: typoscript
hideDefaultLanguageOfPage = TEXT hideDefaultLanguageOfPage = TEXT
hideDefaultLanguageOfPage { hideDefaultLanguageOfPage {
value = 0 value = 0
value { value {
override = 1 override = 1
override.if { override.if {
bitAnd.field = l18n_cfg bitAnd.field = l18n_cfg
value = 1 value = 1
}
} }
}
} }
.. index:: ext:frontend, TypoScript .. index:: ext:frontend, TypoScript
...@@ -15,10 +15,10 @@ AssetCollector is a concept to allow custom CSS/JS code, inline or external, to ...@@ -15,10 +15,10 @@ AssetCollector is a concept to allow custom CSS/JS code, inline or external, to
times in e.g. a Fluid template (via :html:`<f:asset.script>` or :html:`<f:asset.css>` ViewHelpers) but only rendered once times in e.g. a Fluid template (via :html:`<f:asset.script>` or :html:`<f:asset.css>` ViewHelpers) but only rendered once
in the output. in the output.
The :php:`priority` flag (default: :php:`false`) controls where the asset is included: The :php:`priority` flag (default: :php:`false`) controls where the asset is included:
- JavaScript will be output inside :html:`<head>` (:php:`priority`=true) or at the bottom of the :html:`<body>` tag (:php:`priority`=false) * JavaScript will be output inside :html:`<head>` (:php:`priority=true`) or at the bottom of the :html:`<body>` tag (:php:`priority=false`)
- CSS will always be output inside :html:`<head>`, yet grouped by :php:`priority`. * CSS will always be output inside :html:`<head>`, yet grouped by :javascript:`priority`.
By including assets per-component, it can leverage the adoption of HTTP/2 multiplexing which removes the necessity of having all CSS/JavaScript By including assets per-component, it can leverage the adoption of HTTP/2 multiplexing which removes the necessity of having all CSS/JavaScript
concatenated into one file. concatenated into one file.
......
...@@ -12,7 +12,7 @@ Description ...@@ -12,7 +12,7 @@ Description
JavaScript events in custom User Settings Configuration options shall JavaScript events in custom User Settings Configuration options shall
not be placed as inline JavaScript anymore, but utilize a dedicated not be placed as inline JavaScript anymore, but utilize a dedicated
JavaScript module to handle custom events JavaScript module to handle custom events
(see :ref:`Important #91132 <changelog-Important-91132-AvoidJavaScriptInUserSettingsConfigurationOptions>`) (see :doc:`Important-91132-AvoidJavaScriptInUserSettingsConfigurationOptions`)
This new PSR-14 event is introduced: This new PSR-14 event is introduced:
...@@ -75,6 +75,6 @@ A listener using mentioned PSR-14 event could look like the following. ...@@ -75,6 +75,6 @@ A listener using mentioned PSR-14 event could look like the following.
Related Related
======= =======
- :ref:`changelog-Important-91132-AvoidJavaScriptInUserSettingsConfigurationOptions` - :doc:`Important-91132-AvoidJavaScriptInUserSettingsConfigurationOptions`
.. index:: PHP-API, ext:core .. index:: PHP-API, ext:core
...@@ -21,7 +21,7 @@ This step is advised to reduce the amount of inline JavaScript code towards ...@@ -21,7 +21,7 @@ This step is advised to reduce the amount of inline JavaScript code towards
better support for Content-Security-Policy headers. better support for Content-Security-Policy headers.
Applications having custom changes in :php:`$GLOBALS['TYPO3_USER_SETTINGS']` Applications having custom changes in :php:`$GLOBALS['TYPO3_USER_SETTINGS']`
and using mentioned options `onClick*` or ``confirmData.jsCodeAfterOk`. and using mentioned options `onClick*` or `confirmData.jsCodeAfterOk`.
The following example show a potential migration path to avoid inline JavaScript. The following example show a potential migration path to avoid inline JavaScript.
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
======================================================= =======================================================
Important: #93331 - Description of SelectCheckBox items Important: #93331 - Description of SelectCheckBox items
======================================================== =======================================================
See :issue:`93331` See :issue:`93331`
......
...@@ -30,22 +30,22 @@ An example configuration in the :file:`config/sites/<site-name>/config.yml`: ...@@ -30,22 +30,22 @@ An example configuration in the :file:`config/sites/<site-name>/config.yml`:
settings: settings:
categoryPid: 658 categoryPid: 658
  styles: styles:
    content: content:
     loginform: loginform:
        pid: 23 pid: 23
This will make these constants available in the template and in page TSconfig: This will make these constants available in the template and in page TSconfig:
* :ts:`{$categoryPid}` * :typoscript:`{$categoryPid}`
* :ts:`{$styles.content.loginform.pid}` * :typoscript:`{$styles.content.loginform.pid}`
The newly introduced constants for page TSconfig can be used just like constants The newly introduced constants for page TSconfig can be used just like constants
in TypoScript. in TypoScript.
In page TSconfig this can be used like this: In page TSconfig this can be used like this:
.. code-block:: ts .. code-block:: typoscript
# store tx_ext_data records on the given storage page by default (e.g. through IRRE) # store tx_ext_data records on the given storage page by default (e.g. through IRRE)
TCAdefaults.tx_ext_data.pid = {$categoryPid} TCAdefaults.tx_ext_data.pid = {$categoryPid}
......
...@@ -38,41 +38,41 @@ the functionality. Instead, all session properties are placed inside the ...@@ -38,41 +38,41 @@ the functionality. Instead, all session properties are placed inside the
The following public properties within :php:`AbstractUserAuthentication` and The following public properties within :php:`AbstractUserAuthentication` and
its subclasses have been removed: its subclasses have been removed:
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->id` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->id`
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->hash_length` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->hash_length`
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->sessionTimeout` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->sessionTimeout`
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->gc_time` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->gc_time`
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->gc_probability` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->gc_probability`
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->newSessionID` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->newSessionID`
The following public methods within :php:`AbstractUserAuthentication` and its The following public methods within :php:`AbstractUserAuthentication` and its
subclasses have been removed: subclasses have been removed:
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->getNewSessionRecord()` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->getNewSessionRecord()`
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->getSessionId()` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->getSessionId()`
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->isExistingSessionRecord()` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->isExistingSessionRecord()`
The following public property within :php:`AbstractUserAuthentication` has The following public property within :php:`AbstractUserAuthentication` has
changed their visibility to :php:`protected`: changed their visibility to :php:`protected`:
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->lifetime` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->lifetime`
The following public methods within :php:`AbstractUserAuthentication` and its The following public methods within :php:`AbstractUserAuthentication` and its
subclasses have changed their return type: subclasses have changed their return type:
* :php:`TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication->createUserSession()` * :php:`TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication->createUserSession()`
now returns :php:`TYPO3\CMS\Core\Session\UserSession` and the first parameter now returns :php:`TYPO3\CMS\Core\Session\UserSession` and the first parameter
:php:`$tempuser` is now type-hinted :php:`array`. :php:`$tempuser` is now type-hinted :php:`array`.
The following public properties within :php:`FrontendUserAuthentication` have The following public properties within :php:`FrontendUserAuthentication` have
been removed: been removed:
* :php:`TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication->sesData_change` * :php:`TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication->sesData_change`
The following database fields have been removed: The following database fields have been removed:
* :sql:`be_sessions.ses_backuserid` * :sql:`be_sessions.ses_backuserid`
* :sql:`fe_sessions.ses_anonymous` * :sql:`fe_sessions.ses_anonymous`
Impact Impact
...@@ -148,7 +148,7 @@ If a session is anonymous can furthermore be checked using ...@@ -148,7 +148,7 @@ If a session is anonymous can furthermore be checked using
Related Related
======= =======
- :ref:`changelog-Deprecation-93023-ReworkedSessionHandling` - :ref:`changelog-Deprecation-93023-ReworkedSessionHandling`
- :ref:`changelog-Feature-93023-IntroduceUserSessionAndUserSessionManager` - :ref:`changelog-Feature-93023-IntroduceUserSessionAndUserSessionManager`
.. index:: PHP-API, FullyScanned, ext:core .. index:: PHP-API, FullyScanned, ext:core
...@@ -18,8 +18,8 @@ out of the user authentication classes. ...@@ -18,8 +18,8 @@ out of the user authentication classes.
Therefore some properties and methods within :php:`AbstractUserAuthentication` Therefore some properties and methods within :php:`AbstractUserAuthentication`
and its subclasses have been marked as deprecated: and its subclasses have been marked as deprecated:
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->createSessionId()` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->createSessionId()`
* :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->fetchUserSession()` * :php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication->fetchUserSession()`
Impact Impact
...@@ -63,7 +63,8 @@ access this information from an user authentication object, call ...@@ -63,7 +63,8 @@ access this information from an user authentication object, call
Related Related
======= =======
- :ref:`changelog-Breaking-93023-ReworkedSessionHandling` * :ref:`changelog-Breaking-93023-ReworkedSessionHandling`
- :ref:`changelog-Feature-93023-IntroduceUserSessionAndUserSessionManager` * :ref:`changelog-Feature-93023-IntroduceUserSessionAndUserSessionManager`
.. index:: PHP-API, FullyScanned, ext:core .. index:: PHP-API, FullyScanned, ext:core
...@@ -18,7 +18,7 @@ syntax now allows the LLL prefix for the use of language labels. ...@@ -18,7 +18,7 @@ syntax now allows the LLL prefix for the use of language labels.
Example Example
======= =======
.. code-block:: ts .. code-block:: typoscript
options.bookmarkGroups.2 = LLL:EXT:sitepackage/Resources/Private/Language/locallang_be.xlf:bookmarkGroups.2 options.bookmarkGroups.2 = LLL:EXT:sitepackage/Resources/Private/Language/locallang_be.xlf:bookmarkGroups.2
......
...@@ -37,7 +37,7 @@ Migration ...@@ -37,7 +37,7 @@ Migration
Use the new :js:`TYPO3/CMS/T3editor/Element/CodeMirrorElement` module and adapt Use the new :js:`TYPO3/CMS/T3editor/Element/CodeMirrorElement` module and adapt
your markup to read: your markup to read:
.. block:: html .. code-block:: html
<typo3-t3editor-codemirror mode="..." addons="[..]" options="{..}"> <typo3-t3editor-codemirror mode="..." addons="[..]" options="{..}">
<textarea name="foo">..</textarea> <textarea name="foo">..</textarea>
......
...@@ -29,7 +29,7 @@ changes ever since - had several downsides: ...@@ -29,7 +29,7 @@ changes ever since - had several downsides:
* The database field :sql:`be_users.lang` was not really needed * The database field :sql:`be_users.lang` was not really needed
* Administrators did not see available language packs when changing the language * Administrators did not see available language packs when changing the language
* Administrators could only change an editor's preferred language by * Administrators could only change an editor's preferred language by
switching to the user (:pn:`Switch User Mode`). switching to the user (:guilabel:`Switch User Mode`).
* Administrators could not filter / sort editors to see what languages the * Administrators could not filter / sort editors to see what languages the
users had chosen users had chosen
* Fetching the user's preferred language always meant to fetch the whole * Fetching the user's preferred language always meant to fetch the whole
......
...@@ -15,15 +15,15 @@ according functionality has been moved to the legacy extension EXT:compatibility ...@@ -15,15 +15,15 @@ according functionality has been moved to the legacy extension EXT:compatibility
The following TypoScript option has been marked for deprecation: The following TypoScript option has been marked for deprecation:
.. code-block:: ts .. code-block:: typoscript
config.xhtml_cleaning config.xhtml_cleaning
The following PHP method has been marked for deprecation: The following PHP method has been marked for deprecation:
.. code-block:: php .. code-block:: php
TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::doXHTML_cleaning() TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::doXHTML_cleaning()
Impact Impact
====== ======
...@@ -34,7 +34,8 @@ The content output of the TYPO3 frontend is not cleaned anymore unless EXT:compa ...@@ -34,7 +34,8 @@ The content output of the TYPO3 frontend is not cleaned anymore unless EXT:compa
Affected installations Affected installations
====================== ======================
Any installation having the TypoScript option `config.xhtml_cleaning` set will have different behaviour in the Any installation having the TypoScript option :typoscript:`config.xhtml_cleaning`
set will have different behaviour in the
frontend rendering. frontend rendering.
Migration Migration
......
...@@ -12,7 +12,7 @@ Description ...@@ -12,7 +12,7 @@ Description
It was possible to retrieve the local path of a FAL file via TypoScript It was possible to retrieve the local path of a FAL file via TypoScript
.. code-block:: ts .. code-block:: typoscript
a = TEXT a = TEXT
a.value.data = file:current:localPath a.value.data = file:current:localPath
......
...@@ -17,19 +17,19 @@ The following PHP methods within PageRenderer have been removed: ...@@ -17,19 +17,19 @@ The following PHP methods within PageRenderer have been removed:
.. code-block:: php .. code-block:: php
$pageRenderer->setSvgPath() $pageRenderer->setSvgPath()
$pageRenderer->getSvgPath() $pageRenderer->getSvgPath()
$pageRenderer->loadSvg() $pageRenderer->loadSvg()
$pageRenderer->enableSvgDebug() $pageRenderer->enableSvgDebug()
$pageRenderer->svgForceFlash() $pageRenderer->svgForceFlash()
The following TypoScript options are removed: The following TypoScript options are removed:
.. code-block:: ts .. code-block:: typoscript
page.javascriptLibs.SVG page.javascriptLibs.SVG
page.javascriptLibs.SVG.debug page.javascriptLibs.SVG.debug
page.javascriptLibs.SVG.forceFlash page.javascriptLibs.SVG.forceFlash
Impact Impact
......
...@@ -16,16 +16,16 @@ the legacy extension EXT:compatibility6. ...@@ -16,16 +16,16 @@ the legacy extension EXT:compatibility6.
The following TypoScript option has been marked for deprecation: The following TypoScript option has been marked for deprecation:
.. code-block:: ts .. code-block:: typoscript
config.prefixLocalAnchors config.prefixLocalAnchors
The following PHP methods have been marked for deprecation: The following PHP methods have been marked for deprecation:
.. code-block:: php .. code-block:: php
TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::prefixLocalAnchorsWithScript() TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::prefixLocalAnchorsWithScript()
TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::doLocalAnchorFix() TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::doLocalAnchorFix()
Impact Impact
......
...@@ -98,7 +98,7 @@ Migration ...@@ -98,7 +98,7 @@ Migration
If you want to use the JumpURL features you need to install the jumpurl extension. Your configuration should If you want to use the JumpURL features you need to install the jumpurl extension. Your configuration should
work as before. work as before.
Please note that the configuration of the :ref:`filelink <t3tsref:filelink>` TypoScript function has changed. Please note that the configuration of the :ref:`filelink <t3tsref:typolink-resource_references>` TypoScript function has changed.
Passing the :code:`jumpurl` parameter in the configuration has been marked as deprecated and will be removed in future versions. Passing the :code:`jumpurl` parameter in the configuration has been marked as deprecated and will be removed in future versions.
You can now pass arbitrary configuration options for the typolink call that is used to generate You can now pass arbitrary configuration options for the typolink call that is used to generate
...@@ -106,12 +106,12 @@ the file link in the :code:`typolinkConfiguration` parameter: ...@@ -106,12 +106,12 @@ the file link in the :code:`typolinkConfiguration` parameter:
.. code-block:: typoscript .. code-block:: typoscript
lib.myfilelink = TEXT lib.myfilelink = TEXT
lib.myfilelink.value = fileadmin/myfile.txt lib.myfilelink.value = fileadmin/myfile.txt
lib.myfilelink.filelink { lib.myfilelink.filelink {
typolinkConfiguration.jumpurl = 1 typolinkConfiguration.jumpurl = 1
typolinkConfiguration.jumpurl.secure = 1 typolinkConfiguration.jumpurl.secure = 1
} }
.. index:: PHP-API, ext:jumpurl, TypoScript, Frontend .. index:: PHP-API, ext:jumpurl, TypoScript, Frontend
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people