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

   1 ABOUT
   2
   3 Provides integration between Slick carousel and Media entity. Slick media allows
   4 richer slideshow/carousel contents with a mix of text, image and video.
   5
   6 This provides a Slick media formatter for the supported Media entities:
   7   o Media entity image
   8   o Media entity embeddable video
   9
  10
  11 REQUIREMENTS
  12 [1] http://dgo.to/slick
  13 [2] http://dgo.to/media_entity_image
  14 [3] http://dgo.to/media_entity_embeddable_video
  15
  16 The last 2 modules depend on Media entity.
  17
  18
  19 INSTALLATION
  20 Install the module as usual, more info can be found on:
  21 http://drupal.org/documentation/install/modules-themes/modules-7
  22
  23 Enable Slick media module under "Slick" package:
  24 /admin/modules#edit-modules-slick
  25
  26 USAGE / CONFIGURATION
  27 - Enable this module and its dependencies mentioned above.
  28
  29 - At admin/config/people/accounts/fields, Content types or any fieldable entity,
  30   -- click "Manage display".
  31
  32 - Under "Format", choose "Slick media" for Media entity reference field, and
  33   click the "Configure" icon.
  34   Adjust formatter options accordingly, including your optionset.
  35   Be sure a Media entity reference field is already added with the expected
  36   fields for title, caption, image and video. And they are not hidden at the
  37   chosen View mode.
  38
  39 The more complex is your slide, the more options are available.
  40
  41
  42 OPTIONSET
  43 To create your optionsets, go to:
  44
  45 "admin/config/media/slick"
  46
  47
  48 SLIDE LAYOUT
  49 The slide layout option depends on at least a skin selected. No skin, just DIY.
  50 A Media entity is fieldable entity so you can add custom field to hold layout
  51 options. While core image field supports several caption placements/ layout that
  52 affect the entire slides, the fieldable entity may have unique layout per slide
  53 using a dedicated "List (text)" type with the following supported/pre-defined
  54 keys:
  55 top, right, bottom, left, center, below, e.g:
  56
  57 Option #1
  58 ---------
  59
  60 bottom|Caption bottom
  61 top|Caption top
  62 right|Caption right
  63 left|Caption left
  64 center|Caption center
  65 center-top|Caption center top
  66 below|Caption below the slide
  67
  68
  69 Option #2
  70 ---------
  71
  72 If you have complex slide layout via Media entity with overlay video or images
  73 within slide captions, also supported:
  74
  75 stage-right|Caption left, stage right
  76 stage-left|Caption right, stage left
  77
  78
  79 Option #3
  80 ---------
  81
  82 If you choose skin Split, additional layout options supported:
  83
  84 split-right|Caption left, stage right, split half
  85 split-left|Caption right, stage left, split half
  86
  87
  88 Split means image and caption are displayed side by side.
  89
  90 Specific to split layout, be sure to get consistent options (left and right)
  91 per slide, and also choose optionset with skin Split to have a context per
  92 slideshow. Otherwise layout per slideshow with reusable Media files will be
  93 screwed up.
  94
  95 Except the "Caption below the slide" option, all is absolutely positioned aka
  96 overlayed on top of the main slide image/ background for larger monitor.
  97 Those layouts are ideally applied to large displays, not multiple small slides,
  98 nor small carousels, except "Caption below the slide" which is reasonable with
  99 small slides.
 100
 101
 102 Option #4
 103 ---------
 104
 105 Merge all options as needed.
 106
 107
 108 TROUBLESHOOTING
 109 Be sure to first update Blazy and Slick prior to this module update.
 110
 111
 112 AUTHOR/MAINTAINER/CREDITS
 113 gausarts
 114
 115
 116 READ MORE
 117 See the project page on drupal.org: http://drupal.org/project/slick_media.
 118