From 3a337aa4772e60b47ea5ae622f790801a0923139 Mon Sep 17 00:00:00 2001
From: Josef Glatz <josefglatz@gmail.com>
Date: Sat, 18 Apr 2020 07:47:50 +0200
Subject: [PATCH] [DOCS] Add correct indentations in rte_ckeditor documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
This patch takes the changes of the new documentation
theme into account.
Releases: master, 9.5
Resolves: #91102
Change-Id: I3308819227dc4a66f0571e4b5afdc49939f19026
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/64223
Tested-by: Jonas Eberle <flightvision@googlemail.com>
Tested-by: Oliver Bartsch <bo@cedev.de>
Tested-by: Björn Jacob <bjoern.jacob@tritum.de>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Oliver Hader <oliver.hader@typo3.org>
Reviewed-by: Jonas Eberle <flightvision@googlemail.com>
Reviewed-by: Oliver Bartsch <bo@cedev.de>
Reviewed-by: Björn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Oliver Hader <oliver.hader@typo3.org>
---
.../Documentation/Configuration/Examples.rst | 46 +++++++++----------
1 file changed, 22 insertions(+), 24 deletions(-)
diff --git a/typo3/sysext/rte_ckeditor/Documentation/Configuration/Examples.rst b/typo3/sysext/rte_ckeditor/Documentation/Configuration/Examples.rst
index d4b7d42c8c25..c3e393cc3b4a 100644
--- a/typo3/sysext/rte_ckeditor/Documentation/Configuration/Examples.rst
+++ b/typo3/sysext/rte_ckeditor/Documentation/Configuration/Examples.rst
@@ -48,30 +48,28 @@ How Do I Create My Own Preset?
In your sitepackage extension:
-In :file:`ext_localconf`:
+In :file:`ext_localconf.php`, replace `my_extension` with your extension key, replace `my_preset` and `MyPreset.yaml`
+with the name of your preset.
- .. code-block:: php
+.. code-block:: php
- $GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']['my_preset'] = 'EXT:my_extension/Configuration/RTE/MyPreset.yaml';
-
- Replace `my_extension` with your extension key, replace `my_preset` and `MyPreset.yaml`
- with the name of your preset.
+ $GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']['my_preset'] = 'EXT:my_extension/Configuration/RTE/MyPreset.yaml';
In :file:`Configuration/RTE/MyPreset.yaml`, create your configuration, for example:
- .. code-block:: yaml
+.. code-block:: yaml
- # Import basic configuration
- imports:
- - { resource: "EXT:rte_ckeditor/Configuration/RTE/Processing.yaml" }
- - { resource: "EXT:rte_ckeditor/Configuration/RTE/Editor/Base.yaml" }
- - { resource: "EXT:rte_ckeditor/Configuration/RTE/Editor/Plugins.yaml" }
- # Add configuration for the editor
- # For complete documentation see http://docs.ckeditor.com/#!/api/CKEDITOR.config
- editor:
- config:
- # Include custom CSS
- contentsCss: "EXT:my_extension/Resources/Public/Css/rte.css"
+ # Import basic configuration
+ imports:
+ - { resource: "EXT:rte_ckeditor/Configuration/RTE/Processing.yaml" }
+ - { resource: "EXT:rte_ckeditor/Configuration/RTE/Editor/Base.yaml" }
+ - { resource: "EXT:rte_ckeditor/Configuration/RTE/Editor/Plugins.yaml" }
+ # Add configuration for the editor
+ # For complete documentation see http://docs.ckeditor.com/#!/api/CKEDITOR.config
+ editor:
+ config:
+ # Include custom CSS
+ contentsCss: "EXT:my_extension/Resources/Public/Css/rte.css"
How Do I Customize the Toolbar?
===============================
@@ -100,14 +98,14 @@ one or more toolbarGroups.
Example:
- .. code-block:: yaml
+.. code-block:: yaml
- toolbarGroups:
- - { name: clipboard, groups: [ clipboard, cleanup, undo ] }
+ toolbarGroups:
+ - { name: clipboard, groups: [ clipboard, cleanup, undo ] }
- In the example, the toolbar "clipboard" will contain the toolbarGroups "clipboard", "cleanup" and
- "undo" and all buttons which are assigned to these groups will be displayed in the toolbar
- in the defined order.
+In the example, the toolbar "clipboard" will contain the toolbarGroups "clipboard", "cleanup" and
+"undo" and all buttons which are assigned to these groups will be displayed in the toolbar
+in the defined order.
To find out which buttons exist and which are in which toolbar group, you can
go to the `toolbar configurator <https://ckeditor.com/latest/samples/toolbarconfigurator/index.html#basic>`__.
--
GitLab