Commit 95fb2677 authored by Chris Müller's avatar Chris Müller Committed by Nikita Hovratov
Browse files

[DOCS] Remove outdated information from RTE documentation

Additionally, fix some flaws and typos.

Resolves: #97760
Releases: main, 11.5
Change-Id: Ic661dec8a180db640a30fb7305b93e6cdb777efe
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/74877

Tested-by: Björn Jacob's avatarBjörn Jacob <bjoern.jacob@tritum.de>
Tested-by: core-ci's avatarcore-ci <typo3@b13.com>
Tested-by: Nikita Hovratov's avatarNikita Hovratov <nikita.h@live.de>
Reviewed-by: Björn Jacob's avatarBjörn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Nikita Hovratov's avatarNikita Hovratov <nikita.h@live.de>
parent 06aab9ee
...@@ -51,11 +51,6 @@ Editor Configuration ...@@ -51,11 +51,6 @@ Editor Configuration
YAML YAML
---- ----
For TYPO3 v8 the ability to configure editor-related configuration and transformations
via YAML (Yet-Another-Markup-Language) was made available and is usable for both CKEditor
and HtmlArea, although for the latter it is recommended to use the existing configuration
when having special setups.
TYPO3 is using a custom :ref:`YAML API <t3coreapi:yaml-api>` for handling YAML TYPO3 is using a custom :ref:`YAML API <t3coreapi:yaml-api>` for handling YAML
in TYPO3 based on the Symfony YAML package. Therefore environment variables in TYPO3 based on the Symfony YAML package. Therefore environment variables
can be used. can be used.
......
...@@ -8,7 +8,7 @@ TYPO3 Configuration Basics ...@@ -8,7 +8,7 @@ TYPO3 Configuration Basics
========================== ==========================
Just in case you are not familiar with how to configure TYPO3, we will Just in case you are not familiar with how to configure TYPO3, we will
give you a very brief introduction. In case you are , you can safely give you a very brief introduction. Otherwise, you can safely
skip this part and continue reading skip this part and continue reading
:ref:`config-concepts`. :ref:`config-concepts`.
...@@ -34,9 +34,9 @@ Page TSconfig can be used to change: ...@@ -34,9 +34,9 @@ Page TSconfig can be used to change:
RTE.config.tt_content.bodytext.preset = myCustomPreset RTE.config.tt_content.bodytext.preset = myCustomPreset
RTE.config.tx_news_domain_model_news.bodytext.preset = minimal RTE.config.tx_news_domain_model_news.bodytext.preset = minimal
#. Override for one field defined in flexform (:typoscript:`RTE.config.[tableName].[flexForm\.field\.name].preset`):: #. Override for one field defined in flexform (:typoscript:`RTE.config.[tableName].[flexForm.field.name].preset`)::
RTE.config.tt_content.settings\.notifications\.emailText.preset = myCustomPreset RTE.config.tt_content.settings.notifications.emailText.preset = myCustomPreset
#. Override for one field, if type matches (:typoscript:`RTE.config.[tableName].[fieldName].types.[type].preset`):: #. Override for one field, if type matches (:typoscript:`RTE.config.[tableName].[fieldName].types.[type].preset`)::
...@@ -50,15 +50,14 @@ How to change values ...@@ -50,15 +50,14 @@ How to change values
As Page TSconfig always applies to a page and its subpages, you can modify it by As Page TSconfig always applies to a page and its subpages, you can modify it by
editing a page. editing a page.
#. Go to the :guilabel:`"WEB" > "Page"` module. #. Go to the :guilabel:`Web > Page` module.
#. Select a page in the page tree (usually #. Select a page in the page tree (usually your root page).
your root page).
#. Click on the button to :guilabel:`Edit page properties` #. Click on the button to :guilabel:`Edit page properties`
.. figure:: images/edit_page_properties.png .. figure:: images/edit_page_properties.png
:class: with-shadow :class: with-shadow
#. Select the :guilabel:`"Resources"` tab #. Select the :guilabel:`Resources` tab
#. Enter the Page TSconfig in the field :guilabel:`"Page TSconfig"` #. Enter the Page TSconfig in the field :guilabel:`"Page TSconfig"`
...@@ -68,9 +67,7 @@ Additionally, you can add Page TSconfig in an extension: :file:`Configuration/TS ...@@ -68,9 +67,7 @@ Additionally, you can add Page TSconfig in an extension: :file:`Configuration/TS
How to view settings How to view settings
-------------------- --------------------
Go to the module :guilabel:`"WEB" > "Info"` and select :guilabel:`"Page TSconfig"`. Go to the module :guilabel:`Web > Info` and select :guilabel:`Page TSconfig`.
.. _config-typo3-global-configuration: .. _config-typo3-global-configuration:
...@@ -78,7 +75,7 @@ Go to the module :guilabel:`"WEB" > "Info"` and select :guilabel:`"Page TSconfig ...@@ -78,7 +75,7 @@ Go to the module :guilabel:`"WEB" > "Info"` and select :guilabel:`"Page TSconfig
Global Configuration Global Configuration
==================== ====================
Global Configuration is system wide general configuration. Global Configuration is a system-wide general configuration.
Relevant Settings for `rte_ckeditor` Relevant Settings for `rte_ckeditor`
------------------------------------ ------------------------------------
...@@ -95,7 +92,7 @@ How to change values ...@@ -95,7 +92,7 @@ How to change values
-------------------- --------------------
Usually, Global Configuration can be configured in the backend in Usually, Global Configuration can be configured in the backend in
:guilabel:`"ADMIN TOOLS" > "Settings" > "Configure Installation-Wide Options"`. :guilabel:`Admin Tools > Settings > Configure Installation-Wide Options`.
However, the settings relevant for rich text editing, :php:`$GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']` However, the settings relevant for rich text editing, :php:`$GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']`
cannot be configured in the backend. cannot be configured in the backend.
...@@ -116,7 +113,7 @@ How to view settings ...@@ -116,7 +113,7 @@ How to view settings
-------------------- --------------------
You can view the Global Configuration in You can view the Global Configuration in
:guilabel:`"SYSTEM" > "Configuration" > "$GLOBAL['TYPO3_CONF_VARS'] (Global Configuration)" > "RTE"`. :guilabel:`System > Configuration > $GLOBAL['TYPO3_CONF_VARS'] (Global Configuration) > RTE`.
.. figure:: images/global-configuration-rte.png .. figure:: images/global-configuration-rte.png
:class: with-shadow :class: with-shadow
...@@ -171,7 +168,7 @@ How to view settings ...@@ -171,7 +168,7 @@ How to view settings
-------------------- --------------------
You can view TCA in the backend: You can view TCA in the backend:
:guilabel:`"SYSTEM" > "Configuration" > "$GLOBAL['TCA'] (Table configuration array)"`. :guilabel:`System > Configuration > $GLOBAL['TCA'] (Table configuration array)`.
For example, look at :guilabel:`tt_content > columns > bodytext`. For example, look at :guilabel:`tt_content > columns > bodytext`.
......
...@@ -16,8 +16,9 @@ To familiarize yourself with the configuration, look at the existing configurati ...@@ -16,8 +16,9 @@ To familiarize yourself with the configuration, look at the existing configurati
in your TYPO3 website: in your TYPO3 website:
To view the existing RTE presets in the "Global Configuration", go to To view the existing RTE presets in the "Global Configuration", go to
:guilabel:`SYSTEM > Configuration` in the backend, choose :guilabel:`System > Configuration` in the backend, choose
:guilabel:`$GLOBALS['TYPO3_CONF_VARS'] (Global Configuration)` and select RTE: :guilabel:`$GLOBALS['TYPO3_CONF_VARS'] (Global Configuration)` and select
:guilabel:`RTE`:
.. figure:: images/global-configuration-rte.png .. figure:: images/global-configuration-rte.png
:class: with-shadow :class: with-shadow
......
...@@ -12,7 +12,7 @@ Configuration Reference ...@@ -12,7 +12,7 @@ Configuration Reference
YAML Configuration Reference YAML Configuration Reference
============================ ============================
When configurating the CKEditor using YAML, these are the property When configuring the CKEditor using YAML, these are the property
names that are currently used: names that are currently used:
.. contents:: .. contents::
......
...@@ -12,7 +12,7 @@ Editing Modes ...@@ -12,7 +12,7 @@ Editing Modes
CKEditor has three editing modes: CKEditor has three editing modes:
Article Edito mode (classic RTE) Article Editor mode (classic RTE)
Editing is done within a fixed container. Editing is done within a fixed container.
It is possible to customize how the editor behaves and how the content is styled. It is possible to customize how the editor behaves and how the content is styled.
......
...@@ -7,20 +7,20 @@ ...@@ -7,20 +7,20 @@
Installation Installation
============ ============
TYPO3 v9 and higher The system extension is part of common Composer distributions such as
=================== `typo3/cms-base-distribution <https://packagist.org/packages/typo3/cms-base-distribution>`__.
It is activated by default and ships with a default configuration for editors.
For installations since TYPO3 version 9 LTS, `rte_ckeditor` is activated by If you don't use any distribution the system extension can be installed via:
default and ships with a default configuration for editors.
If you installed TYPO3 via composer with "subtree split", you must install
the extension, for example:
.. code-block:: bash .. code-block:: bash
composer require typo3/cms-rte-ckeditor:~10.4 composer require typo3/cms-rte-ckeditor
Legacy installations
====================
See :ref:`t3coreapi:extension-install` in TYPO3 Explained for more information For legacy installations that do not use Composer, EXT:rte_ckeditor is already
about installing extensions. part of the distributed package.
.. todo: screenshot of extension manager? Activate the :guilabel:`RTE CKEditor` extension in :guilabel:`Admin Tools > Extension Manager`.
...@@ -37,12 +37,11 @@ History ...@@ -37,12 +37,11 @@ History
CKEditor was officially integrated as the default rich text editor in TYPO3 v8 LTS, CKEditor was officially integrated as the default rich text editor in TYPO3 v8 LTS,
within an extension called `rte_ckeditor`. within an extension called `rte_ckeditor`.
Before TYPO3 v8, a custom fork of HtmlArea, another open-source WYSIWYG editor Before TYPO3 v8, a custom fork of "HtmlArea", another open-source WYSIWYG editor
was shipped with TYPO3 Core in a separate extension `rtehtmlarea`. "HtmlArea" was shipped with TYPO3 Core in a separate extension `rtehtmlarea`. "HtmlArea"
isn't supported anymore since TYPO3 v9 LTS. You have to migrate to `rte_ckeditor` isn't supported anymore since TYPO3 v9 LTS. You have to migrate to `rte_ckeditor`
when upgrading from previous TYPO3 versions (=< v8). when upgrading from previous TYPO3 versions (=< v8).
It's highly recommended to use CKEditor as the editor in TYPO3 v8 LTS instances.
.. _features: .. _features:
......
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