diff --git a/typo3/sysext/rte_ckeditor/Documentation/Configuration/Concepts.rst b/typo3/sysext/rte_ckeditor/Documentation/Configuration/Concepts.rst index 66552026766c6c410aeb5422bf9882d4eaf452f7..fd1bb48c0f61ec34afbdc1c11d90858381bc6b40 100644 --- a/typo3/sysext/rte_ckeditor/Documentation/Configuration/Concepts.rst +++ b/typo3/sysext/rte_ckeditor/Documentation/Configuration/Concepts.rst @@ -51,11 +51,6 @@ Editor Configuration 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 in TYPO3 based on the Symfony YAML package. Therefore environment variables can be used. diff --git a/typo3/sysext/rte_ckeditor/Documentation/Configuration/ConfigureTypo3.rst b/typo3/sysext/rte_ckeditor/Documentation/Configuration/ConfigureTypo3.rst index ed90b6750e3f1fe61ddaf4f97de4fe4a96709914..e2d86ce8f6db125523476d20413da17bc6336c3e 100644 --- a/typo3/sysext/rte_ckeditor/Documentation/Configuration/ConfigureTypo3.rst +++ b/typo3/sysext/rte_ckeditor/Documentation/Configuration/ConfigureTypo3.rst @@ -8,7 +8,7 @@ TYPO3 Configuration Basics ========================== 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 :ref:`config-concepts`. @@ -34,9 +34,9 @@ Page TSconfig can be used to change: RTE.config.tt_content.bodytext.preset = myCustomPreset 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`):: @@ -50,15 +50,14 @@ How to change values As Page TSconfig always applies to a page and its subpages, you can modify it by editing a page. -#. Go to the :guilabel:`"WEB" > "Page"` module. -#. Select a page in the page tree (usually - your root page). +#. Go to the :guilabel:`Web > Page` module. +#. Select a page in the page tree (usually your root page). #. Click on the button to :guilabel:`Edit page properties` .. figure:: images/edit_page_properties.png :class: with-shadow -#. Select the :guilabel:`"Resources"` tab +#. Select the :guilabel:`Resources` tab #. 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 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: @@ -78,7 +75,7 @@ Go to the module :guilabel:`"WEB" > "Info"` and select :guilabel:`"Page TSconfig Global Configuration ==================== -Global Configuration is system wide general configuration. +Global Configuration is a system-wide general configuration. Relevant Settings for `rte_ckeditor` ------------------------------------ @@ -95,7 +92,7 @@ How to change values -------------------- 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']` cannot be configured in the backend. @@ -116,7 +113,7 @@ How to view settings -------------------- 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 :class: with-shadow @@ -171,7 +168,7 @@ How to view settings -------------------- 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`. diff --git a/typo3/sysext/rte_ckeditor/Documentation/Configuration/QuickStart.rst b/typo3/sysext/rte_ckeditor/Documentation/Configuration/QuickStart.rst index 4945d83790bc4756819305f257b083b5a8972a4c..59fc07798cafa6693ca753a6a03d3baf5aefc5c7 100644 --- a/typo3/sysext/rte_ckeditor/Documentation/Configuration/QuickStart.rst +++ b/typo3/sysext/rte_ckeditor/Documentation/Configuration/QuickStart.rst @@ -16,8 +16,9 @@ To familiarize yourself with the configuration, look at the existing configurati in your TYPO3 website: To view the existing RTE presets in the "Global Configuration", go to -:guilabel:`SYSTEM > Configuration` in the backend, choose -:guilabel:`$GLOBALS['TYPO3_CONF_VARS'] (Global Configuration)` and select RTE: +:guilabel:`System > Configuration` in the backend, choose +:guilabel:`$GLOBALS['TYPO3_CONF_VARS'] (Global Configuration)` and select +:guilabel:`RTE`: .. figure:: images/global-configuration-rte.png :class: with-shadow diff --git a/typo3/sysext/rte_ckeditor/Documentation/Configuration/Reference.rst b/typo3/sysext/rte_ckeditor/Documentation/Configuration/Reference.rst index a3719879759ad915fb91c40374ea675f6595a3bc..d680a32bdfb642106bc8003c9eb763e1e22cd809 100644 --- a/typo3/sysext/rte_ckeditor/Documentation/Configuration/Reference.rst +++ b/typo3/sysext/rte_ckeditor/Documentation/Configuration/Reference.rst @@ -12,7 +12,7 @@ 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: .. contents:: diff --git a/typo3/sysext/rte_ckeditor/Documentation/GeneralConcepts/Index.rst b/typo3/sysext/rte_ckeditor/Documentation/GeneralConcepts/Index.rst index eb48c40ce8be85897213e770fece39a8282259a8..f7d550bd0fddfcb2d7a60c92d8e8e6b02208b550 100644 --- a/typo3/sysext/rte_ckeditor/Documentation/GeneralConcepts/Index.rst +++ b/typo3/sysext/rte_ckeditor/Documentation/GeneralConcepts/Index.rst @@ -12,7 +12,7 @@ Editing Modes CKEditor has three editing modes: -Article Edito mode (classic RTE) +Article Editor mode (classic RTE) Editing is done within a fixed container. It is possible to customize how the editor behaves and how the content is styled. diff --git a/typo3/sysext/rte_ckeditor/Documentation/Installation/Index.rst b/typo3/sysext/rte_ckeditor/Documentation/Installation/Index.rst index 40f670e521ebf7d8f14657c6fb8e7afd28ccd314..060855f4ed60c998dab267f654afd69342364036 100644 --- a/typo3/sysext/rte_ckeditor/Documentation/Installation/Index.rst +++ b/typo3/sysext/rte_ckeditor/Documentation/Installation/Index.rst @@ -7,20 +7,20 @@ 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 -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: +If you don't use any distribution the system extension can be installed via: .. 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 -about installing extensions. +For legacy installations that do not use Composer, EXT:rte_ckeditor is already +part of the distributed package. -.. todo: screenshot of extension manager? +Activate the :guilabel:`RTE CKEditor` extension in :guilabel:`Admin Tools > Extension Manager`. diff --git a/typo3/sysext/rte_ckeditor/Documentation/Introduction/Index.rst b/typo3/sysext/rte_ckeditor/Documentation/Introduction/Index.rst index 5f4b480ef2068d3604ed7a46e3a018a96103c2db..e69207410a7a3705ec8006891c19c3c7a5b15523 100644 --- a/typo3/sysext/rte_ckeditor/Documentation/Introduction/Index.rst +++ b/typo3/sysext/rte_ckeditor/Documentation/Introduction/Index.rst @@ -37,12 +37,11 @@ History CKEditor was officially integrated as the default rich text editor in TYPO3 v8 LTS, 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" isn't supported anymore since TYPO3 v9 LTS. You have to migrate to `rte_ckeditor` when upgrading from previous TYPO3 versions (=< v8). -It's highly recommended to use CKEditor as the editor in TYPO3 v8 LTS instances. .. _features: