[Task]: Add a migration list (#4)

* Docs: add a migration list * Apply php-cs-fixer changes * Update doc/01_Migration_to_Quill.md Co-authored-by: Bernhard Rusch <[email protected]> * Update doc/01_Migration_to_Quill.md Co-authored-by: Bernhard Rusch <[email protected]> * Task: add replace section --------- Co-authored-by: robertSt7 <[email protected]> Co-authored-by: Bernhard Rusch <[email protected]>
pimcore · Dec 4, 2024 · 09ea289 · 09ea289
1 parent 64d8c20
commit 09ea289
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,9 @@ This includes the WYSIWYG for Documents, Data Objects and Shared Translations.
 ## Installation
 See [Installation](./doc/00_Installation.md)
 
+## Migration to Quill
+See [Migration](./doc/01_Migration_to_Quill.md)
+
 ## Configuration
 
 Available configuration options can be found here: [config options](https://quilljs.com/docs/configuration/)
@@ -18,7 +21,7 @@ Available themes and how to configure it can be found here: [themes](https://qui
 ### Basic usage
 
 `wysiwyg` helper doesn't require any additional configuration options.
-The following code add a second toolbar.
+The following code customize the toolbar.
 
 ```twig
 <section id="marked-content">
@@ -28,14 +31,13 @@ The following code add a second toolbar.
     }}
 </section>
 ```
-![Wysiwyg with extended toolbar - editmode](./doc/img/editables_wysiwyg_toolbar_editmode.png)
 
 ### Custom configuration for Quill
 
 A list of configuration options you can find in the [Quill toolbar documentation](https://quilljs.com/docs/modules/toolbar).
 
 The WYSIWYG editable allows us to specify the toolbar.
-If you have to limit styling options (for example only basic styles like `<b>` tag and lists would be allowed), just use `toolbar1` option.
+If you have to limit styling options (for example only basic styles like `<b>` tag and lists would be allowed), just use `toolbar` option.
 
 ```twig
 <section id="marked-content">

diff --git a/doc/01_Migration_to_Quill.md b/doc/01_Migration_to_Quill.md
@@ -0,0 +1,34 @@
+# Migration to Quill 
+
+Every WYSIWYG-Editor (TinyMCE, CKEditor, ...) has its own peculiarities, that means that they are never 100% compatible to each other. Potential incompatibilities can result into different markup or styling, in rare edge-cases even in a kind of data-loss if the existing markup is not supported by Quill. Therefore it's important to check your existing contents for compatibility with the editor. 
+
+## Replace TinyMCE with Quill
+
+First install Quill: [Installation](./00_Installation.md)
+
+### Bundles
+
+Make sure TinyMCE isn't enabled in the `config/bundles.php` file. The following lines should be removed:
+
+```php
+use Pimcore\Bundle\TinymceBundle\PimcoreTinymceBundle;
+// ...
+
+return [
+    // ...
+    PimcoreTinymceBundle::class => ['all' => true],
+    // ...
+];
+```
+
+## Known incompatibilities
+
+### Configuration
+
+Change the twig and public configs according to [config options](https://quilljs.com/docs/configuration/)
+
+### Tables & Lists
+
+Tables & Lists form TinyMCE could be displayed different in Quill than in TinyMCE. Please check your fields after migration.
+
+