Updated to Drupal 8.5. Core Media not yet in use.
[yaffs-website] / web / modules / contrib / paragraphs / README.txt
index f32e165046c450de854b181db0b51e34689d2dab..ef1885f537b6adc35583edbefeca8ce844881000 100644 (file)
@@ -2,7 +2,7 @@ README.txt
 ==========
 
 Paragraph is a module to create paragraphs in your content.
-You can create types(with own display and fields) as paragraph types.
+You can create types(with own display and fields) as Paragraph types.
 
 When you use the Entity Reference Paragraphs widget + Entity Reference selection
 type on your node/entity, you can select the allowed types, and when using the
@@ -10,10 +10,43 @@ widget, you can select a paragraph type from the allowed types to use
 different fields/display per paragraph.
 
 * Different fields per paragraph type
-* Using different paragraph types in a single paragraph field
+* Using different Paragraph types in a single Paragraph field
 * Displays per paragraph type
 
-CONFIGURATION
+WIDGETS
+-------------
+
+Paragraphs currently provides two different widgets that can be used.
+
+ * Classic: a stable UI with limited features that will not be changed or
+   updated.
+
+ * Experimental: This widget provides additional features like duplicating
+   paragraphs and a drag & drop mode (see below) as well a improved user
+   experience. It is just as well tested as the classic UI but major changes
+   between versions are to be expected.
+
+Drag & drop
+-------------
+
+The experimental widget offers a separate mode that allows to re-sort paragraphs
+not just within the same level but it is also possible to change the hierarchy
+and move paragraphs including their children around and into other paragraphs.
+
+During drag & drop mode, paragraphs are also displayed as a summary only, which
+results in a very compact display that makes it easier to move them around.
+
+To use this, an additional library is necessary, which needs to be put in the
+/libraries folder. Download from https://github.com/RubaXa/Sortable/releases,
+make sure that the folder name is Sortable (with uppercase S) so that the path
+to the javascript file is /libraries/Sortable/Sortable.min.js.
+
+Due to a known issue (https://github.com/RubaXa/Sortable/pull/1154), either
+version 1.5.1 should be used or the patch from that pull request.
+
+If the file exists, the feature will automatically be available.
+
+MULTILINGUAL CONFIGURATION
 -------------
  * Enable the Paragraph module.