www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/paragraphs/README.txt

   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  * Classic: a stable UI with limited features that will not be changed or
  22    updated.
  23
  24  * Experimental: This widget provides additional features like duplicating
  25    paragraphs and a drag & drop mode (see below) as well a improved user
  26    experience. It is just as well tested as the classic UI but major changes
  27    between versions are to be expected.
  28
  29 Drag & drop
  30 -------------
  31
  32 The experimental widget offers a separate mode that allows to re-sort paragraphs
  33 not just within the same level but it is also possible to change the hierarchy
  34 and move paragraphs including their children around and into other paragraphs.
  35
  36 During drag & drop mode, paragraphs are also displayed as a summary only, which
  37 results in a very compact display that makes it easier to move them around.
  38
  39 To use this, an additional library is necessary, which needs to be put in the
  40 /libraries folder. Download from https://github.com/RubaXa/Sortable/releases,
  41 make sure that the folder name is Sortable (with uppercase S) so that the path
  42 to the javascript file is /libraries/Sortable/Sortable.min.js.
  43
  44 Due to a known issue (https://github.com/RubaXa/Sortable/pull/1154), either
  45 version 1.5.1 should be used or the patch from that pull request.
  46
  47 If the file exists, the feature will automatically be available.
  48
  49 MULTILINGUAL CONFIGURATION
  50 -------------
  51  * Enable the Paragraph module.
  52
  53  * Add new languages for the translation in Configuration » Languages.
  54
  55  * Enable any custom content type with a paragraph field to be translatable in
  56  Configuration » Content language
  57  and translation:
  58
  59    - Under Custom language settings check Content.
  60
  61       - Under Content check the content type with a paragraph field.
  62
  63    - Make sure that the paragraph field is set to NOT translatable.
  64
  65    - Set the fields of each paragraph type to translatable as required.
  66
  67  * Check Paragraphs as the embedded reference in Configuration » Translation
  68  Management settings.
  69
  70  * Create a new content - Paragraphed article and translate it.
  71
  72
  73 LIMITATION
  74 -------------
  75 For now, this module does not support switching entity reference revision field
  76 of the paragraph itself into multilingual mode. This would raise complexity
  77 significantly.
  78 Check #2461695: Support translatable paragraph entity reference revision field
  79 (https://www.drupal.org/node/2461695).