www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/slick/src/Plugin/Field/README.txt

   1 ABOUT
   2
   3 Adds a field display formatter to allow you to display field content using
   4 Slick carousel. The module doesn't require Field UI to be enabled by default
   5 (so you can leave it off once everything is configured) but it is recommended
   6 to use to setup your display settings.
   7
   8
   9 SUPPORTED FIELDS
  10 All is applicable only to multi-value fields.
  11 - Image
  12 - Text, Text long, Text with summary
  13 - Media Entity via slick_media contrib [1]
  14 - Paragraphs via slick_paragraphs contrib [2]
  15
  16 [1] http://dgo.to/slick_media
  17 [2] http://dgo.to/slick_paragraphs
  18
  19
  20 USAGE
  21
  22 Manage the fields on any entity (e.g.: node of type Article):
  23
  24 "admin/structure/types/manage/article/display"
  25
  26 Select any field of type "Image", "Media Entity" or "Paragraphs" and set the
  27 display options to "Slick Text", "Slick Image", "Slick Media" or
  28 "Slick Paragraphs", "Slick ...", accordingly under "Format".
  29
  30 Adjust formatter options accordingly, including your optionset.
  31
  32 The more complex is your slide, the more options are available.
  33
  34 If using Media, Paragraphs, or other Slick entity reference formatters, be
  35 sure to provide relevant View mode, and the fields are made visible at their own
  36 Manage display page.
  37
  38 You can put any field type as Caption fields, and have custom work going such as
  39 with animated caption fields with animate.css, etc. using a long text field.
  40 Further work is required like everything else, but the ease of field composition
  41 is there without too much custom code, except for CSS which is normal for any
  42 site building.
  43
  44 OPTIONSET
  45 To create your option sets, go to:
  46
  47 "admin/config/media/slick"
  48
  49
  50 SLIDE LAYOUT
  51 The slide layout option depends on at least a skin selected. No skin, just DIY.
  52 Core image field support several caption placements/ layout that affect the
  53 entire slides uniformly.
  54
  55 If you have more complex need, use Media entity, Paragraphs, or other Slick ERs.
  56 You can place caption at different positions per individual slide as long as you
  57 provide a dedicated "List (text)" with the following supported/pre-defined keys:
  58 top, right, bottom, left, center, below, e.g:
  59
  60 Option #1
  61 ---------
  62
  63 bottom|Caption bottom
  64 top|Caption top
  65 right|Caption right
  66 left|Caption left
  67 center|Caption center
  68 center-top|Caption center top
  69 below|Caption below the slide
  70
  71
  72 Option #2
  73 ---------
  74
  75 If you have complex slide layout via Media Entity/ Paragraphs with overlay video
  76 or images within slide captions, also supported:
  77
  78 stage-right|Caption left, stage right
  79 stage-left|Caption right, stage left
  80 stage-zebra|Stage zebra
  81
  82
  83 Option #3
  84 ---------
  85
  86 If you choose skin Split, additional layout options supported:
  87
  88 split-right|Caption left, stage right, split half
  89 split-left|Caption right, stage left, split half
  90 split-zebra|Split zebra
  91
  92
  93 Split means image and caption are displayed side by side.
  94
  95 Specific to split layout, be sure to get consistent options (left and right)
  96 per slide, and also choose Skin main "Split" to have a context per
  97 slideshow. Otherwise layout per slideshow is useless.
  98
  99 Except the "Caption below the slide" option, all is absolutely positioned aka
 100 overlayed on top of the main slide image/ background for larger monitor.
 101 Those layouts are ideally applied to large displays, not multiple small slides,
 102 nor small carousels, except "Caption below the slide" which is reasonable with
 103 small slides.
 104
 105
 106 Option #4
 107 ---------
 108
 109 Merge all options as needed.