README.txt

Same filename in this branch
  1. 8.x-1.x paragraphs/README.txt
  2. 8.x-1.x paragraphs/tests/fixtures/update/README.txt
README.txt
==========

Paragraph is a module to create paragraphs in your content.
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
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
* Displays per paragraph type

WIDGETS
-------------

Paragraphs currently provides two different widgets that can be used.

 * Legacy (formerly Classic): a stable UI with limited features that will not be
   changed or updated.

 * Stable (formerly Experimental): This widget provides additional features like
   duplicating paragraphs and a drag & drop mode (see below) as well a improved
   user experience. It is now the default and recommended widget, but changes
   between versions are to be expected and customizations might need to be
   updated.

Drag & drop
-------------

The stable 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.

Starting with Drupal 8.8.0, the necessary library is part of Drupal core and
this feature is always available.

Use the version 1.10+ as it's tested and approved. Older versions may introduce
bugs with nested drag & drop functionality.

If the file exists, the feature will automatically be available.

MULTILINGUAL CONFIGURATION
-------------
 * Enable the Paragraph module.

 * Add new languages for the translation in Configuration » Languages.

 * Enable any custom content type with a paragraph field to be translatable in
 Configuration » Content language
 and translation:

   - Under Custom language settings check Content.

      - Under Content check the content type with a paragraph field.

   - Make sure that the paragraph field is set to NOT translatable.

   - Set the fields of each paragraph type to translatable as required.

 * Check Paragraphs as the embedded reference in Configuration » Translation
 Management settings.

 * Create a new content - Paragraphed article and translate it.


LIMITATION
-------------
For now, this module does not support switching entity reference revision field
of the paragraph itself into multilingual mode. This would raise complexity
significantly.
Check #2461695: Support translatable paragraph entity reference revision field
(https://www.drupal.org/node/2461695).

File

paragraphs/README.txt
View source
  1. README.txt

  2. ==========

  3. 

  4. Paragraph is a module to create paragraphs in your content.

  5. You can create types(with own display and fields) as Paragraph types.

  6. 

  7. When you use the Entity Reference Paragraphs widget + Entity Reference selection

  8. type on your node/entity, you can select the allowed types, and when using the

  9. widget, you can select a paragraph type from the allowed types to use

  10. different fields/display per paragraph.

  11. 

  12. * Different fields per paragraph type

  13. * Using different Paragraph types in a single Paragraph field

  14. * Displays per paragraph type

  15. 

  16. WIDGETS

  17. -------------

  18. 

  19. Paragraphs currently provides two different widgets that can be used.

  20. 

  21.  * Legacy (formerly Classic): a stable UI with limited features that will not be

  22.    changed or updated.

  23. 

  24.  * Stable (formerly Experimental): This widget provides additional features like

  25.    duplicating paragraphs and a drag & drop mode (see below) as well a improved

  26.    user experience. It is now the default and recommended widget, but changes

  27.    between versions are to be expected and customizations might need to be

  28.    updated.

  29. 

  30. Drag & drop

  31. -------------

  32. 

  33. The stable widget offers a separate mode that allows to re-sort paragraphs

  34. not just within the same level but it is also possible to change the hierarchy

  35. and move paragraphs including their children around and into other paragraphs.

  36. 

  37. During drag & drop mode, paragraphs are also displayed as a summary only, which

  38. results in a very compact display that makes it easier to move them around.

  39. 

  40. Starting with Drupal 8.8.0, the necessary library is part of Drupal core and

  41. this feature is always available.

  42. 

  43. Use the version 1.10+ as it's tested and approved. Older versions may introduce

  44. bugs with nested drag & drop functionality.

  45. 

  46. If the file exists, the feature will automatically be available.

  47. 

  48. MULTILINGUAL CONFIGURATION

  49. -------------

  50.  * Enable the Paragraph module.

  51. 

  52.  * Add new languages for the translation in Configuration » Languages.

  53. 

  54.  * Enable any custom content type with a paragraph field to be translatable in

  55.  Configuration » Content language

  56.  and translation:

  57. 

  58.    - Under Custom language settings check Content.

  59. 

  60.       - Under Content check the content type with a paragraph field.

  61. 

  62.    - Make sure that the paragraph field is set to NOT translatable.

  63. 

  64.    - Set the fields of each paragraph type to translatable as required.

  65. 

  66.  * Check Paragraphs as the embedded reference in Configuration » Translation

  67.  Management settings.

  68. 

  69.  * Create a new content - Paragraphed article and translate it.

  70. 

  71. 

  72. LIMITATION

  73. -------------

  74. For now, this module does not support switching entity reference revision field

  75. of the paragraph itself into multilingual mode. This would raise complexity

  76. significantly.

  77. Check #2461695: Support translatable paragraph entity reference revision field

  78. (https://www.drupal.org/node/2461695).