Commit 1a25aee3 authored by Christian Kuhn's avatar Christian Kuhn
Browse files

[BUGFIX] Changelog docs compile warnings

Fix a series of ReST documentation compile warnings, some of them
lead to missing segments in the rendered docs. Most notable changes:

* Always have an empty line after '.. code-block:: <highlight-indicator>'
* Introduce inline text role ":javascript:" and use it consistently over
  ":js:", but give it the same HTML class "js" during rendering. This is
  because highlight code-block existists for "javascript", too, so this
  can now be used both in blocks as well as inline
* Introduce inline text role ":sql:", can now be used inline, too, in
  addition to code-block
* Various minor things like indentings in numerations, some broken
  tables, ...

Change-Id: Id9c16257a76623dc9ee292253450865b95e13dc3
Resolves: #83313
Releases: master
Reviewed-on: https://review.typo3.org/55063

Tested-by: default avatarTYPO3com <no-reply@typo3.com>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
parent b1c5f122
......@@ -16,12 +16,12 @@ The `flashmessage_compatibility.js` has been removed from the core.
Impact
======
Extensions which make use of :js:`TYPO3.Flashmessage` JavaScript function will not work anymore.
Extensions which make use of :javascript:`TYPO3.Flashmessage` JavaScript function will not work anymore.
Migration
=========
Use :js:`top.TYPO3.Notification.*` to create flash messages within JavaScript for the TYPO3 backend.
Use :javascript:`top.TYPO3.Notification.*` to create flash messages within JavaScript for the TYPO3 backend.
.. index:: JavaScript
......@@ -10,24 +10,24 @@ See :issue:`73442`
Description
===========
The method :js:`Modal.getSeverityClass` has been moved to :js:`Severity.getCssClass`. :js:`Modal.getSeverityClass` has been marked as deprecated.
The method :javascript:`Modal.getSeverityClass` has been moved to :javascript:`Severity.getCssClass`. :javascript:`Modal.getSeverityClass` has been marked as deprecated.
Impact
======
Calling :js:`Modal.getSeverityClass` will trigger a console warning in the browser.
Calling :javascript:`Modal.getSeverityClass` will trigger a console warning in the browser.
Affected Installations
======================
All 3rd party extensions using :js:`Modal.getSeverityClass` are affected.
All 3rd party extensions using :javascript:`Modal.getSeverityClass` are affected.
Migration
=========
Change the calls to :js:`Severity.getCssClass(severity)`.
Change the calls to :javascript:`Severity.getCssClass(severity)`.
.. index:: JavaScript, Backend
......@@ -20,14 +20,23 @@ Impact
======
The wizard component has the following public methods:
#. :code:`addSlide(identifier, title, content, severity, callback)`
#. :code:`addFinalProcessingSlide(callback)`
#. :code:`set(key, value)`
#. :code:`show()`
#. :code:`dismiss()`
#. :code:`getComponent()`
#. :code:`lockNextStep()`
#. :code:`unlockNextStep()`
* :code:`addSlide(identifier, title, content, severity, callback)`
* :code:`addFinalProcessingSlide(callback)`
* :code:`set(key, value)`
* :code:`show()`
* :code:`dismiss()`
* :code:`getComponent()`
* :code:`lockNextStep()`
* :code:`unlockNextStep()`
addSlide
~~~~~~~~
......@@ -43,15 +52,15 @@ content string Yes The content of the slide
severity int Represents the severity of a slide. Please see TYPO3.Severity. Default is :code:`TYPO3.Severity.info`.
callback function Callback method run after the slide appeared. The callback receives two parameters:
:code:`$slide`: The current slide as a jQuery object
:code:`settings`: The settings defined via :js:`Wizard.set()`
:code:`settings`: The settings defined via :javascript:`Wizard.set()`
========== =============== ============ ======================================================================================================
addFinalProcessingSlide
~~~~~~~~~~~~~~~~~~~~~~~
Adds a slide to the wizard containing a spinner. This should always be the latest slide. This method returns a Promise
object due to internal handling. This means you have to add a :js:`done()` callback containing :js:`Wizard.show()` and ,
:js:`Wizard.getComponent()` please see the example below.
object due to internal handling. This means you have to add a :javascript:`done()` callback containing :javascript:`Wizard.show()` and
:javascript:`Wizard.getComponent()` please see the example below.
========== =============== ============ ======================================================================================================
Name DataType Mandatory Description
......@@ -62,7 +71,7 @@ callback function Callback method run after the slide appe
Example code:
.. code-block:: js
.. code-block:: javascript
Wizard.addFinalProcessingSlide().done(function() {
Wizard.show();
......@@ -92,7 +101,7 @@ The event `wizard-visible` is fired when the wizard rendering has finished.
Example code:
.. code-block:: js
.. code-block:: javascript
Wizard.getComponent().on('wizard-visible', function() {
Wizard.unlockNextButton();
......@@ -103,16 +112,16 @@ Wizards can be closed by firing the `wizard-dismiss` event.
Example code:
.. code-block:: js
.. code-block:: javascript
Wizard.getComponent().trigger('wizard-dismiss');
Wizards fire the `wizard-dismissed` event if the wizard is closed. You can integrate your own listener by using :js:`Wizard.getComponent()`.
Wizards fire the `wizard-dismissed` event if the wizard is closed. You can integrate your own listener by using :javascript:`Wizard.getComponent()`.
Example code:
.. code-block:: js
.. code-block:: javascript
Wizard.getComponent().on('wizard-dismissed', function() {
// Calculate the answer of life the universe and everything
......
......@@ -10,13 +10,13 @@ See :issue:`75386`
Description
===========
The callback of :js:`Wizard.addSlide()` now has a new parameter `identifier`.
The callback of :javascript:`Wizard.addSlide()` now has a new parameter `identifier`.
Impact
======
The identifier is passed to the callback function of :js:`Wizard.addSlide()`.
The identifier is passed to the callback function of :javascript:`Wizard.addSlide()`.
Example code:
......
......@@ -14,10 +14,10 @@ The popup window configuration has been moved to `TYPO3.settings`.
The following configuration options are not working anymore.
:js:`top.TYPO3.configuration.RTEPopupWindow.width`
:js:`top.TYPO3.configuration.RTEPopupWindow.height`
:js:`top.TYPO3.configuration.PopupWindow.width`
:js:`top.TYPO3.configuration.PopupWindow.height`
:javascript:`top.TYPO3.configuration.RTEPopupWindow.width`
:javascript:`top.TYPO3.configuration.RTEPopupWindow.height`
:javascript:`top.TYPO3.configuration.PopupWindow.width`
:javascript:`top.TYPO3.configuration.PopupWindow.height`
Impact
......@@ -37,12 +37,12 @@ Migration
The migration can be done with the following replacements.
:js:`top.TYPO3.configuration.RTEPopupWindow.width` to :js:`TYPO3.settings.Textarea.RTEPopupWindow.width`
:javascript:`top.TYPO3.configuration.RTEPopupWindow.width` to :javascript:`TYPO3.settings.Textarea.RTEPopupWindow.width`
:js:`top.TYPO3.configuration.RTEPopupWindow.height` to :js:`TYPO3.settings.Textarea.RTEPopupWindow.height`
:javascript:`top.TYPO3.configuration.RTEPopupWindow.height` to :javascript:`TYPO3.settings.Textarea.RTEPopupWindow.height`
:js:`top.TYPO3.configuration.PopupWindow.width` to :js:`TYPO3.settings.Popup.PopupWindow.width`
:javascript:`top.TYPO3.configuration.PopupWindow.width` to :javascript:`TYPO3.settings.Popup.PopupWindow.width`
:js:`top.TYPO3.configuration.PopupWindow.height` to :js:`TYPO3.settings.Popup.PopupWindow.height`
:javascript:`top.TYPO3.configuration.PopupWindow.height` to :javascript:`TYPO3.settings.Popup.PopupWindow.height`
.. index:: JavaScript, Backend
......@@ -43,7 +43,7 @@ Test-Files
Any test file must be located in extension folder `typo3/sysext/<EXTKEY>/Tests/JavaScript/`
The filename must end with Test.js, e.g. `GridEditorTest.js`
Each test file must be implemented as AMD module, must use strict mode and has to use :js:`describe` with module name as outer wrap for each test.
Each test file must be implemented as AMD module, must use strict mode and has to use :javascript:`describe` with module name as outer wrap for each test.
The following code block shows a good example:
.. code-block:: javascript
......@@ -68,7 +68,7 @@ Please take a look at the existing test files and read the jasmine documentation
DataProvider for tests
----------------------
For testing a set of values, the core implement a kind of DataProvider. To use the DataProvider you have to use the function :js:`using`.
For testing a set of values, the core implement a kind of DataProvider. To use the DataProvider you have to use the function :javascript:`using`.
Please take a look at `FormEngineValidationTest.js` for an example.
.. index:: JavaScript
......@@ -20,14 +20,14 @@ It also polluted backend user settings with tons of data without giving much usa
Impact
======
Any JS code referencing ExtJS component :js:`TYPO3.Components.Tree` or its sub-components
(like :js:`TYPO3.Components.Tree.StandardTree`) will no longer work.
Any JS code referencing ExtJS component :javascript:`TYPO3.Components.Tree` or its sub-components
(like :javascript:`TYPO3.Components.Tree.StandardTree`) will no longer work.
Affected Installations
======================
All installations having extensions which modify the :js:`TYPO3.Components.Tree`
All installations having extensions which modify the :javascript:`TYPO3.Components.Tree`
(implemented in `typo3/sysext/backend/Resources/Public/JavaScript/tree.js`) component,
or rely on the file being present.
......
......@@ -49,6 +49,6 @@ buildButtonConfig
The method takes now two additional arguments: `active` and `severity`. The parameter `active` is a boolean
value and declares the button being either active or not. The parameter `severity` is an integer representing the
severity of the button. This should always represent the severity of the modal, use one of the severities defined in
:js:`TYPO3/CMS/Backend/Severity`.
:javascript:`TYPO3/CMS/Backend/Severity`.
.. index:: JavaScript, RTE
......@@ -36,7 +36,7 @@ Data binding
------------
Thanks to D3, each SVG node representing tree item is bound to the data object. The general idea is that all operations (like showing/hiding/selecting...) are first performed on the dataset, and then the view (SVG) is refreshed.
In the :js:`initialize` function SvgTree loads the whole tree as json
In the :javascript:`initialize` function SvgTree loads the whole tree as json
Impact
......
......@@ -37,7 +37,7 @@ An example:
will be compiled to:
:js:`define(["require", "exports", "TYPO3/CMS/Core/Contrib/jquery.minicolors"], function (require, exports, minicolors) {`
:javascript:`define(["require", "exports", "TYPO3/CMS/Core/Contrib/jquery.minicolors"], function (require, exports, minicolors) {`
A very simple example is the `EXT:backend/Resources/Private/TypeScript/ColorPicker.ts` file.
......@@ -54,11 +54,11 @@ Additional Rules
For the core we have defined some additional rules which you should know, because not all of them can be checked by the Linter yet:
#. Always define types and return types, also if TypeScript provides a default type. [checked by Linter]
#. Variable scoping: Prefer :js:`let` instead of :js:`var`. [checked by Linter]
#. Variable scoping: Prefer :javascript:`let` instead of :javascript:`var`. [checked by Linter]
#. Optional properties in interfaces are possible but a bad style, this is not allowed for the core. [NOT checked by Linter]
#. An interface will never extend a class. [NOT checked by Linter]
#. Iterables: Use :js:`for (i of list)` if possible instead of :ts:`for (i in list)` [NOT checked by Linter]
#. The :js:`implements` keyword is required for any usage, also if TypeScript does not require it. [NOT checked by Linter]
#. Iterables: Use :javascript:`for (i of list)` if possible instead of :ts:`for (i in list)` [NOT checked by Linter]
#. The :javascript:`implements` keyword is required for any usage, also if TypeScript does not require it. [NOT checked by Linter]
#. Any class or interface must be declared with "export" to ensure re-use or export an instance of the object for existing code which can't be updated now. [NOT checked by Linter]
......
......@@ -39,13 +39,3 @@ Deprecation
:glob:
Deprecation-*
Important
^^^^^^^^^
.. toctree::
:maxdepth: 1
:titlesonly:
:glob:
Important-*
......@@ -12,10 +12,10 @@ Description
The following JavaScript methods related to ExtJS have been removed from the Backend main frame
as defined in the main `backend.js` file.
:js:`TYPO3._instances`
:js:`TYPO3.addInstance`
:js:`TYPO3.getInstance`
:js:`TYPO3.helpers.split`
:javascript:`TYPO3._instances`
:javascript:`TYPO3.addInstance`
:javascript:`TYPO3.getInstance`
:javascript:`TYPO3.helpers.split`
Impact
......
......@@ -16,7 +16,7 @@ as the option of opening the debug information in a window was migrated already.
Impact
======
The setting is not available anymore in JavaScript under :js:`TYPO3.configuration`.
The setting is not available anymore in JavaScript under :javascript:`TYPO3.configuration`.
Affected Installations
......
......@@ -11,14 +11,14 @@ Description
Removed all options that are not used anymore from TYPO3.configuration in JavaScript context.
:js:`TYPO3.configuration.moduleMenuWidth`
:js:`TYPO3.configuration.topBarHeight`
:javascript:`TYPO3.configuration.moduleMenuWidth`
:javascript:`TYPO3.configuration.topBarHeight`
Impact
======
Both settings are not available anymore in JavaScript under :js:`TYPO3.configuration`.
Both settings are not available anymore in JavaScript under :javascript:`TYPO3.configuration`.
Affected Installations
......
......@@ -9,7 +9,7 @@ See :issue:`78279`
Description
===========
The property :js:`top.TYPO3.Backend.ContentContainer.iframe` has been marked as deprecated.
The property :javascript:`top.TYPO3.Backend.ContentContainer.iframe` has been marked as deprecated.
Impact
......@@ -21,12 +21,12 @@ Using this property will stop working in TYPO3 v9.
Affected Installations
======================
All installations using :js:`top.TYPO3.Backend.ContentContainer.iframe`.
All installations using :javascript:`top.TYPO3.Backend.ContentContainer.iframe`.
Migration
=========
Use accessor method :js:`top.TYPO3.Backend.ContentContainer.get()` instead.
Use accessor method :javascript:`top.TYPO3.Backend.ContentContainer.get()` instead.
.. index:: Backend
......@@ -9,7 +9,8 @@ See :issue:`17904`
Description
===========
HMENU setting `showAccessRestrictedPages`=NONE now acts as documented in https://docs.typo3.org/typo3cms/TyposcriptReference/MenuObjects/CommonProperties/Index.html.
HMENU setting `showAccessRestrictedPages=NONE` now acts as documented in
:ref:`TypoScript reference <t3tsref:menu-common-properties>`.
Before: using the option renders `<a>Page title</a>` when page is inaccessible.
......
......@@ -27,8 +27,8 @@ Classes removed
ExtJS component removed
-----------------------
- The :js:`TYPO3.Components.PageTree.ContextMenu` component defined in contextmenu.js has been removed.
- The `contextMenuProvider` property as well as `enableContextMenu` and `openContextMenu` methods of the :js:`TYPO3.Components.PageTree.Tree` component have been removed.
- The :javascript:`TYPO3.Components.PageTree.ContextMenu` component defined in contextmenu.js has been removed.
- The `contextMenuProvider` property as well as `enableContextMenu` and `openContextMenu` methods of the :javascript:`TYPO3.Components.PageTree.Tree` component have been removed.
Migration
^^^^^^^^^
......@@ -95,7 +95,7 @@ Changed markup (data attributes) for click menu
- for files, `data-table` now contains the real table name "sys_file" while before it contained the combined identifier e.g. `1:/fileadmin/file.jpg`.
the `data-uid` attribute now contains the combined identifier of the file (before it was empty).
Thus the `data-uid` attribute value is not always an int.
- the class which triggers the context-menu has changed from :js:`t3-js-clickmenutrigger` to :js:`t3js-contextmenutrigger`
- the class which triggers the context-menu has changed from :javascript:`t3-js-clickmenutrigger` to :javascript:`t3js-contextmenutrigger`
Migration
......
......@@ -15,24 +15,33 @@ has been migrated to a Symfony Console command.
The command previously available via `./typo3/cli_dispatch.phpsh lowlevel_cleaner versions` is now available
via `./typo3/sysext/core/bin/typo3 cleanup:versions` and allows the following CLI options to be set:
The following options can be set
`--action={nameofaction}` to clean up versioned records, one of the following actions are possible:
"versions_in_live": Delete versioned records in the live workspace
"published_versions": Delete versions of published records
"invalid_workspace": Move records inside a non-existing workspace ID into the live workspace
"unused_placeholders": Remove placeholders which are not used anymore from the database
`-v` and `-vv` to show more detailed information on the records affected
`--pid=23` or `-p=23` to only find versions with page ID 23 (otherwise "0" is taken)
`--depth=4` or `-d=4` to only clean recursively until a certain page tree level.
`--dry-run` to only show the records to be changed / deleted
The following options can be set:
The PHP class of the old CLI command `TYPO3\CMS\Lowlevel\VersionsCommand` has been removed.
- :shell:`--action={nameofaction}` to clean up versioned records, one of the following actions are possible:
- "versions_in_live": Delete versioned records in the live workspace
- "published_versions": Delete versions of published records
- "invalid_workspace": Move records inside a non-existing workspace ID into the live workspace
- "unused_placeholders": Remove placeholders which are not used anymore from the database
- :shell:`-v` and :shell:`-vv` to show more detailed information on the records affected
- :shell:`--pid=23` or :shell:`-p=23` to only find versions with page ID 23 (otherwise "0" is taken)
- :shell:`--depth=4` or :shell:`-d=4` to only clean recursively until a certain page tree level.
- :shell:`--dry-run` to only show the records to be changed / deleted
The PHP class of the old CLI command :php:`TYPO3\CMS\Lowlevel\VersionsCommand` has been removed.
Impact
======
Calling the old CLI command `./typo3/cli_dispatch.phpsh lowlevel_cleaner versions` will result in an error message.
Calling the old CLI command :shell:`./typo3/cli_dispatch.phpsh lowlevel_cleaner versions` will result in an error message.
Affected Installations
......
......@@ -15,7 +15,7 @@ The file structures of CSS Styled Content and Fluid Styled Content have been str
File structure of CSS Styled Content
------------------------------------
.. code-block::
.. code-block:: php
- Configuration/TypoScript
| - ContentElement
......@@ -57,7 +57,7 @@ File structure of CSS Styled Content
File structure of Fluid Styled Content
--------------------------------------
.. code-block::
.. code-block:: php
- Configuration/TypoScript
| - ContentElement
......
......@@ -14,6 +14,7 @@ Enabling richtext rendering for fields in the Backend record editor has been sim
In the past, a typical :php:`TCA` configuration of a richtext field looked like:
.. code-block:: php
'columns' => [
'content' => [
'config' => [
......@@ -26,6 +27,7 @@ In the past, a typical :php:`TCA` configuration of a richtext field looked like:
The :php:`defaultExtras` is obsolete and substituted with :php:`enableRichtext` within the :php:`config` section:
.. code-block:: php
'columns' => [
'content' => [
'config' => [
......@@ -39,6 +41,7 @@ The :php:`defaultExtras` is obsolete and substituted with :php:`enableRichtext`
If the RTE was enabled for a specific type only, it looked like this:
.. code-block:: php
'columns' => [
'content' => [
'config' => [
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment